public class SSBasedInspection extends LocalInspectionTool implements DynamicGroupTool
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
SHORT_NAME |
EMPTY_ARRAY, VALID_ID_PATTERN
myNameProvider
Constructor and Description |
---|
SSBasedInspection() |
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.
|
buildVisitor, checkFile, getAlternativeID, getID, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile
createOptionsPanel, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, isEnabledByDefault, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions
public static final java.lang.String SHORT_NAME
public void writeSettings(Element node) throws WriteExternalException
InspectionProfileEntry
int TOOL_OPTION
)
and bean-style getters/setters (like int getToolOption(), void setToolOption(int)
) to store your options.writeSettings
in class InspectionProfileEntry
node
- to store settings to.WriteExternalException
public void readSettings(Element node) throws InvalidDataException
InspectionProfileEntry
int TOOL_OPTION
)
and bean-style getters/setters (like int getToolOption(), void setToolOption(int)
) to store your options.readSettings
in class InspectionProfileEntry
node
- to read settings from.InvalidDataException
- if the loaded data was not valid.public java.lang.String getGroupDisplayName()
getGroupDisplayName
in class InspectionProfileEntry
InspectionEP.groupDisplayName
,
InspectionEP.groupKey
,
InspectionEP.groupBundle
public java.lang.String getShortName()
InspectionProfileEntry
getShortName
in class InspectionProfileEntry
InspectionEP.shortName
public void initialize(GlobalInspectionContext context)
initialize
in class InspectionProfileEntry
public void cleanup(Project project)
cleanup
in class InspectionProfileEntry
public PsiElementVisitor buildVisitor(ProblemsHolder holder, boolean isOnTheFly)
LocalInspectionTool
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.buildVisitor
in class LocalInspectionTool
holder
- where visitor will register problems found.isOnTheFly
- true if inspection was run in non-batch modePsiRecursiveVisitor
public java.util.List<LocalInspectionToolWrapper> getChildren()
getChildren
in interface DynamicGroupTool
public java.util.List<Configuration> getConfigurations()
public java.util.List<Configuration> getConfigurationsWithUuid(java.util.UUID uuid)
public void addConfiguration(Configuration configuration)
public void removeConfiguration(Configuration configuration)
public void removeConfigurationWithUuid(java.util.UUID uuid)