Package com.intellij.structuralsearch.inspection

Class SSBasedInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.structuralsearch.inspection.SSBasedInspection

All Implemented Interfaces:

BatchSuppressableTool, DynamicGroupTool

public class SSBasedInspection
extends LocalInspectionTool
implements DynamicGroupTool

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SHORT_NAME

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
SSBasedInspection()

Method Summary

Modifier and Type	Method and Description
void	addConfiguration(Configuration configuration)
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
void	cleanup(Project project)
java.util.List<LocalInspectionToolWrapper>	getChildren()
java.util.List<Configuration>	getConfigurations()
java.util.List<Configuration>	getConfigurationsWithUuid(java.util.UUID uuid)
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
void	initialize(GlobalInspectionContext context)
void	readSettings(Element node) Read in settings from XML config.
void	removeConfiguration(Configuration configuration)
void	removeConfigurationWithUuid(java.util.UUID uuid)
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

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

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

createOptionsPanel, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, isEnabledByDefault, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions

Methods inherited from class java.lang.Object

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

Field Detail

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

SSBasedInspection

public SSBasedInspection()

Method Detail

writeSettings

public void writeSettings(Element node)
                   throws WriteExternalException

Description copied from class: InspectionProfileEntry

Store current settings in XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

writeSettings in class InspectionProfileEntry

Parameters:

node - to store settings to.

Throws:

WriteExternalException

readSettings

public void readSettings(Element node)
                  throws InvalidDataException

Description copied from class: InspectionProfileEntry

Read in settings from XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

readSettings in class InspectionProfileEntry

Parameters:

node - to read settings from.

Throws:

InvalidDataException - if the loaded data was not valid.

getGroupDisplayName

public java.lang.String getGroupDisplayName()

Overrides:

getGroupDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle

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

initialize

public void initialize(GlobalInspectionContext context)

Overrides:

initialize in class InspectionProfileEntry

cleanup

public void cleanup(Project project)

Overrides:

cleanup in class InspectionProfileEntry

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly)

Description copied from class: LocalInspectionTool

Override the method to provide your own inspection visitor. Created visitor must not be recursive (e.g. it must not inherit PsiRecursiveElementVisitor) since it will be fed with every element in the file anyway. Visitor created must be thread-safe since it might be called on several elements concurrently.

Overrides:

buildVisitor in class LocalInspectionTool

Parameters:

holder - where visitor will register problems found.

isOnTheFly - true if inspection was run in non-batch mode

Returns:

not-null visitor for this inspection.

See Also:

PsiRecursiveVisitor

getChildren

public java.util.List<LocalInspectionToolWrapper> getChildren()

Specified by:

getChildren in interface DynamicGroupTool

getConfigurations

public java.util.List<Configuration> getConfigurations()

getConfigurationsWithUuid

public java.util.List<Configuration> getConfigurationsWithUuid(java.util.UUID uuid)

addConfiguration

public void addConfiguration(Configuration configuration)

removeConfiguration

public void removeConfiguration(Configuration configuration)

removeConfigurationWithUuid

public void removeConfigurationWithUuid(java.util.UUID uuid)