Package com.intellij.structuralsearch.inspection

Class StructuralSearchFakeInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.structuralsearch.inspection.StructuralSearchFakeInspection

All Implemented Interfaces:

BatchSuppressableTool

public class StructuralSearchFakeInspection
extends LocalInspectionTool

Field Summary

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool

EMPTY_ARRAY, VALID_ID_PATTERN

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
StructuralSearchFakeInspection(Configuration configuration)
StructuralSearchFakeInspection(StructuralSearchFakeInspection copy)

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
java.lang.String	getAlternativeID() For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
java.lang.String	getDisplayName()
java.lang.String	getGroupDisplayName()
java.lang.String	getID() If you want to change suppression id you have to define it in XML as well.
java.lang.String	getMainToolId()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
java.lang.String	getStaticDescription() Override this method to return a HTML inspection description.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.
void	setProfile(InspectionProfileImpl profile)

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, buildVisitor, checkFile, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getGeneralGroupName, getGroupKey, getGroupPath, getSerializationFilter, getShortName, getSuppressors, initialize, isInitialized, isSuppressedFor, loadDescription, readSettings, showDefaultConfigurationOptions, writeSettings

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StructuralSearchFakeInspection

public StructuralSearchFakeInspection(Configuration configuration)

StructuralSearchFakeInspection

public StructuralSearchFakeInspection(StructuralSearchFakeInspection copy)

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Overrides:

getDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.displayName, InspectionEP.key, InspectionEP.bundle

getShortName

public java.lang.String getShortName()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

getShortName in class InspectionProfileEntry

See Also:

InspectionEP.shortName

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

getID

public java.lang.String getID()

Description copied from class: LocalInspectionTool

If you want to change suppression id you have to define it in XML as well.

Inspection tool ID is a descriptive name to be used in "suppress" comments and annotations.

It must satisfy LocalInspectionTool.VALID_ID_PATTERN regexp pattern.

If not defined InspectionProfileEntry.getShortName() is used as tool ID.

Overrides:

getID in class LocalInspectionTool

Returns:

inspection tool ID.

getAlternativeID

public java.lang.String getAlternativeID()

Description copied from class: InspectionProfileEntry

For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage

Overrides:

getAlternativeID in class LocalInspectionTool

getMainToolId

public java.lang.String getMainToolId()

Overrides:

getMainToolId in class InspectionProfileEntry

Returns:

short name of tool whose results will be used

getGroupDisplayName

public java.lang.String getGroupDisplayName()

Overrides:

getGroupDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle

getStaticDescription

public java.lang.String getStaticDescription()

Description copied from class: InspectionProfileEntry

Override this method to return a HTML inspection description. Otherwise it will be loaded from resources using ID.

Overrides:

getStaticDescription in class InspectionProfileEntry

Returns:

hard-coded inspection description.

setProfile

public void setProfile(InspectionProfileImpl profile)

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Description copied from class: InspectionProfileEntry

This method is called each time UI is shown.

Overrides:

createOptionsPanel in class InspectionProfileEntry

Returns:

null if no UI options required.