Package com.intellij.codeInspection.miscGenerics

Class GenericsInspectionToolBase

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.miscGenerics.GenericsInspectionToolBase

All Implemented Interfaces:

BatchSuppressableTool, CleanupLocalInspectionTool

Direct Known Subclasses:

RedundantArrayForVarargsCallInspection, RedundantCastInspection, RedundantTypeArgsInspection

public abstract class GenericsInspectionToolBase
extends AbstractBaseJavaLocalInspectionTool
implements CleanupLocalInspectionTool

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

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(PsiClass aClass, InspectionManager manager, boolean isOnTheFly) Override this to report problems at class level.
ProblemDescriptor[]	checkField(PsiField field, InspectionManager manager, boolean isOnTheFly) Override this to report problems at field level.
ProblemDescriptor[]	checkMethod(PsiMethod psiMethod, InspectionManager manager, boolean isOnTheFly) Override this to report problems at method level.
abstract ProblemDescriptor []	getDescriptions(PsiElement place, InspectionManager manager, boolean isOnTheFly)
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.

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

cleanup, createOptionsPanel, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupDisplayName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getShortName, getStaticDescription, 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

GenericsInspectionToolBase

public GenericsInspectionToolBase()

Method Detail

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

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 AbstractBaseJavaLocalInspectionTool

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

checkClass

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

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at class level.

Overrides:

checkClass in class AbstractBaseJavaLocalInspectionTool

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(PsiField field,
                                      InspectionManager manager,
                                      boolean isOnTheFly)

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at field level.

Overrides:

checkField in class AbstractBaseJavaLocalInspectionTool

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.

checkMethod

public ProblemDescriptor[] checkMethod(PsiMethod psiMethod,
                                       InspectionManager manager,
                                       boolean isOnTheFly)

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at method level.

Overrides:

checkMethod in class AbstractBaseJavaLocalInspectionTool

Parameters:

psiMethod - 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.

getDescriptions

public abstract ProblemDescriptor [] getDescriptions(PsiElement place,
                                                     InspectionManager manager,
                                                     boolean isOnTheFly)