Package com.intellij.codeInspection

Class LocalInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

AbstractBaseJavaLocalInspectionTool, AbstractBaseUastLocalInspectionTool, AbstractNamingConventionInspection, AbstractToStringInspection, AlphaUnsortedPropertiesFileInspection, AnonymousGroupInspection, BaseCommitMessageInspection, BuildoutUnresolvedPartInspection, CommandLineInspection, DeprecatedIsStillUsedInspection, DeprecationInspectionBase, DuplicateAlternationBranchInspection, DuplicateBranchesInSwitchInspection, DuplicateExpressionsInspection, DuplicatesInspectionBase, EmptyAlternationBranchInspection, EscapedMetaCharacterInspection, GroovySuppressableInspectionTool, GrUnusedDefaultParameterInspection, IgnoreFileDuplicateEntryInspection, IncompletePropertyInspection, InconsistentLineSeparatorsInspection, InjectedReferencesInspection, JavaDocLocalInspection, JavaDocReferenceInspection, JsonDuplicatePropertyKeysInspection, JsonSchemaBasedInspectionBase, JsonStandardComplianceInspection, JvmLocalInspection, LongLineInspection, LossyEncodingInspection, MissingFinalNewlineInspection, MisspelledHeaderInspection, NonAsciiCharactersInspection, OctalEscapeInspection, ProblematicWhitespaceInspection, PropertiesInspectionBase, PyInspection, ReDoSInspection, RedundantEscapeInspection, RedundantLabeledSwitchRuleCodeBlockInspection, RepeatedSpaceInspection, RestInspection, ShShellcheckInspection, SingleCharAlternationInspection, SpellCheckingInspection, SSBasedInspection, StructuralSearchFakeInspection, SuspiciousLocalesLanguagesInspection, SwitchLabeledRuleCanBeCodeBlockInspection, TemplateInvocationInspection, TestFailedLineInspection, TodoCommentInspection, UnexpectedAnchorInspection, UnusedElementInspection, VariableShadowingInspection, XmlSuppressableInspectionTool, XPathInspection, XsltDeclarationInspection, YAMLDuplicatedKeysInspection, YamlJsonSchemaInspectionBase, YamlMetaTypeInspectionBase, YAMLRecursiveAliasInspection, YAMLUnresolvedAliasInspection, YAMLUnusedAnchorInspection

public abstract class LocalInspectionTool
extends InspectionProfileEntry

Field Summary

Fields

Modifier and Type	Field and Description
static LocalInspectionTool[]	EMPTY_ARRAY
static java.lang.String	VALID_ID_PATTERN Pattern used for inspection ID validation.

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
LocalInspectionTool()

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly, LocalInspectionToolSession session) Override the method to provide your own inspection visitor, if you need to store additional state in the LocalInspectionToolSession user data or get information about the inspection scope.
ProblemDescriptor []	checkFile(PsiFile file, InspectionManager manager, boolean isOnTheFly) Override this to report problems at file level.
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	getID() If you want to change suppression id you have to define it in XML as well.
PsiNamedElement	getProblemElement(PsiElement psiElement) The method finds problem container (ex: method, class, file) that used to be shown as inspection view tree node.
protected java.lang.String	getSuppressId() Tool ID passed to InspectionSuppressor.
void	inspectionFinished(LocalInspectionToolSession session) Deprecated. Use inspectionFinished(LocalInspectionToolSession, ProblemsHolder) instead
void	inspectionFinished(LocalInspectionToolSession session, ProblemsHolder problemsHolder)
void	inspectionStarted(LocalInspectionToolSession session, boolean isOnTheFly)
static boolean	isValidID(java.lang.String id)
java.util.List<ProblemDescriptor>	processFile(PsiFile file, InspectionManager manager)
boolean	runForWholeFile() Override this method and return true if your inspection (unlike almost all others) must be called for every element in the whole file for each change, whatever small it was.

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

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

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_ARRAY

public static final LocalInspectionTool[] EMPTY_ARRAY

VALID_ID_PATTERN

public static final java.lang.String VALID_ID_PATTERN

Pattern used for inspection ID validation.

See Also:

Constant Field Values

Constructor Detail

LocalInspectionTool

public LocalInspectionTool()

Method Detail

isValidID

public static boolean isValidID(java.lang.String id)

getID

public java.lang.String getID()

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 VALID_ID_PATTERN regexp pattern.

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

Returns:

inspection tool ID.

getSuppressId

protected final java.lang.String getSuppressId()

Description copied from class: InspectionProfileEntry

Tool ID passed to InspectionSuppressor.

Overrides:

getSuppressId in class InspectionProfileEntry

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 InspectionProfileEntry

runForWholeFile

public boolean runForWholeFile()

Override this method and return true if your inspection (unlike almost all others) must be called for every element in the whole file for each change, whatever small it was.

For example, 'Field can be local' inspection can report the field declaration when reference to it was added inside method hundreds lines below. Hence, this inspection must be rerun on every change.

Please note that re-scanning the whole file can take considerable time and thus seriously impact the responsiveness, so beg please use this mechanism once in a blue moon.

Returns:

true if inspection should be called for every element.

checkFile

public ProblemDescriptor [] checkFile(PsiFile file,
                                      InspectionManager manager,
                                      boolean isOnTheFly)

Override this to report problems at file level.

Parameters:

file - to check.

manager - InspectionManager to ask for ProblemDescriptor's from.

isOnTheFly - true if called during on the fly editor highlighting. Called from Inspect Code action otherwise.

Returns:

null if no problems found or not applicable at file level.

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly,
                                      LocalInspectionToolSession session)

Override the method to provide your own inspection visitor, if you need to store additional state in the LocalInspectionToolSession user data or get information about the inspection scope. 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.

Parameters:

holder - where visitor will register problems found.

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

session - the session in the context of which the tool runs.

Returns:

not-null visitor for this inspection.

See Also:

PsiRecursiveVisitor

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly)

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.

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

getProblemElement

public PsiNamedElement getProblemElement(PsiElement psiElement)

The method finds problem container (ex: method, class, file) that used to be shown as inspection view tree node. Consider RefManagerExtension.getElementContainer(PsiElement) to override container element for any inspection for given language.

Parameters:

psiElement: - problem element

Returns:

problem container element

inspectionStarted

public void inspectionStarted(LocalInspectionToolSession session,
                              boolean isOnTheFly)

inspectionFinished

public void inspectionFinished(LocalInspectionToolSession session,
                               ProblemsHolder problemsHolder)

inspectionFinished

@Deprecated
public void inspectionFinished(LocalInspectionToolSession session)

Deprecated. Use inspectionFinished(LocalInspectionToolSession, ProblemsHolder) instead

processFile

public java.util.List<ProblemDescriptor> processFile(PsiFile file,
                                                     InspectionManager manager)