Package com.intellij.codeInspection

Class AbstractBaseUastLocalInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseUastLocalInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

BlockingMethodInNonBlockingContextInspection, I18nInspection, StringToUpperWithoutLocale2Inspection, SuspiciousPackagePrivateAccessInspection

public abstract class AbstractBaseUastLocalInspectionTool
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

Modifier	Constructor and Description
protected	AbstractBaseUastLocalInspectionTool()
protected	AbstractBaseUastLocalInspectionTool(java.lang.Class<? extends UElement>... uElementsTypesHint)

Method Summary

Modifier and Type	Method and Description
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
ProblemDescriptor []	checkClass(UClass aClass, InspectionManager manager, boolean isOnTheFly) Override this to report problems at class level.
ProblemDescriptor []	checkField(UField field, InspectionManager manager, boolean isOnTheFly) Override this to report problems at field level.
ProblemDescriptor []	checkMethod(UMethod method, InspectionManager manager, boolean isOnTheFly) Override this to report problems at method level.
PsiNamedElement	getProblemElement(PsiElement psiElement) The method finds problem container (ex: method, class, file) that used to be shown as inspection view tree node.

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

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

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

Constructor Detail

AbstractBaseUastLocalInspectionTool

protected AbstractBaseUastLocalInspectionTool()

AbstractBaseUastLocalInspectionTool

protected AbstractBaseUastLocalInspectionTool(java.lang.Class<? extends UElement>... uElementsTypesHint)

Method Detail

checkMethod

public ProblemDescriptor [] checkMethod(UMethod method,
                                        InspectionManager manager,
                                        boolean isOnTheFly)

Override this to report problems at method level.

Parameters:

method - to check.

manager - InspectionManager to ask for ProblemDescriptors 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 method level.

checkClass

public ProblemDescriptor [] checkClass(UClass aClass,
                                       InspectionManager manager,
                                       boolean isOnTheFly)

Override this to report problems at class level.

Parameters:

aClass - to check.

manager - InspectionManager to ask for ProblemDescriptors 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 class level.

checkField

public ProblemDescriptor [] checkField(UField field,
                                       InspectionManager manager,
                                       boolean isOnTheFly)

Override this to report problems at field level.

Parameters:

field - to check.

manager - InspectionManager to ask for ProblemDescriptors 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 field level.

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

getProblemElement

public PsiNamedElement getProblemElement(PsiElement psiElement)

Description copied from class: LocalInspectionTool

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.

Overrides:

getProblemElement in class LocalInspectionTool

Returns:

problem container element