Package com.intellij.codeInspection

Class AbstractBaseJavaLocalInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

AccessStaticViaInstanceBase, AnonymousCanBeLambdaInspection, AnonymousCanBeMethodReferenceInspection, AnonymousHasLambdaAlternativeInspection, AppEngineForbiddenCodeInspection, BaseFormInspection, BaseInspection, BaseJavaBatchLocalInspectionTool, BaseJavaLocalInspectionTool, BaseLocalInspectionTool, BlockMarkerCommentsInspection, BooleanMethodIsAlwaysInvertedLocalInspection, BoundedWildcardInspection, BoundFieldAssignmentInspection, CapturingCleanerInspection, CastCanBeRemovedNarrowingVariableTypeInspection, CatchMayIgnoreExceptionInspection, CharsetObjectCanBeUsedInspection, ClassEscapesItsScopeInspection, ClassGetClassInspection, CollectionAddAllCanBeReplacedWithConstructorInspection, ComparatorCombinatorsInspection, ComparatorResultComparisonInspection, ConditionalBreakInInfiniteLoopInspection, ConditionalCanBeOptionalInspection, ConditionCoveredByFurtherConditionInspection, ConstantExpressionInspection, ContractInspection, DataFlowInspectionBase, DefaultAnnotationParamInspection, DefaultFileTemplateUsageInspection, DefUseInspection, DependencyInspection, DuplicateStringLiteralInspection, DuplicateThrowsInspection, EndlessStreamInspection, EnhancedSwitchBackwardMigrationInspection, EnhancedSwitchMigrationInspection, EnumSwitchStatementWhichMissesCasesInspection, EqualsAndHashcodeBase, ExcessiveLambdaUsageInspection, ExcessiveRangeCheckInspection, ExplicitArgumentCanBeLambdaInspection, ExplicitArrayFillingInspection, ExplicitTypeCanBeDiamondInspection, FieldAccessNotGuardedInspection, FieldCanBeLocalInspection, FoldExpressionIntoStreamInspection, ForwardCompatibilityInspection, FrequentlyUsedInheritorInspection, FunctionalExpressionCanBeFoldedInspection, FuseStreamOperationsInspection, GenericsInspectionToolBase, GuavaInspection, IdempotentLoopBodyInspection, IfStatementWithIdenticalBranchesInspection, InstanceGuardedByStaticInspection, InvalidComparatorMethodReferenceInspection, InvalidPropertyKeyInspection, IterableUsedAsVarargInspection, Java15APIUsageInspection, Java8CollectionRemoveIfInspection, Java8ListSortInspection, Java8MapApiInspection, Java8MapForEachInspection, Java9CollectionFactoryInspection, Java9ModuleExportsPackageToItselfInspection, Java9ReflectionClassVisibilityInspection, Java9UndeclaredServiceUsageInspection, JavacQuirksInspection, JavaLangInvokeHandleSignatureInspection, JavaModuleNamingInspection, JavaReflectionInvocationInspection, JavaReflectionMemberAccessInspection, JavaRequiresAutoModuleInspection, JoinDeclarationAndAssignmentJavaInspection, LambdaCanBeMethodCallInspection, LambdaCanBeMethodReferenceInspection, ListRemoveInLoopInspection, LocalCanBeFinal, MagicConstantInspection, ManualMinMaxCalculationInspection, MetaAnnotationWithoutRuntimeRetentionInspection, MigrateAssertToMatcherAssertInspection, MismatchedStringCaseInspection, MissingOverrideAnnotationInspection, MoveFieldAssignmentToInitializerInspection, NonFinalFieldInImmutableInspection, NonFinalGuardInspection, NotNullFieldNotInitializedInspection, NullableStuffInspectionBase, NumericOverflowInspection, ObjectsEqualsCanBeSimplifiedInspection, ObviousNullCheckInspection, OptionalAssignedToNullInspection, OptionalGetWithoutIsPresentInspection, OptionalIsPresentInspection, OptionalToIfInspection, OverflowingLoopIndexInspection, OverwrittenKeyInspection, ParameterCanBeLocalInspection, PatternVariableCanBeUsedInspection, PossibleHeapPollutionVarargsInspection, RawTypeCanBeGenericInspection, ReadWriteStringCanBeUsedInspection, RedundantClassCallInspection, RedundantCollectionOperationInspection, RedundantComparatorComparingInspection, RedundantCompareCallInspection, RedundantExplicitCloseInspection, RedundantExplicitVariableTypeInspection, RedundantLambdaCodeBlockInspection, RedundantLambdaParameterTypeInspection, RedundantOperationOnEmptyContainerInspection, RedundantRecordConstructorInspection, RedundantStreamOptionalCallInspection, RedundantStringOperationInspection, RedundantThrowsDeclarationLocalInspection, ReplaceInefficientStreamCountInspection, ReplaceNullCheckInspection, ReturnSeparatedFromComputationInspection, SillyAssignmentInspection, SimplifiableIfStatementInspection, SimplifyCollectorInspection, SimplifyForEachInspection, SimplifyOptionalCallChainsInspection, SimplifyStreamApiCallChainsInspection, SortedCollectionWithNonComparableKeysInspection, StaticGuardedByInstanceInspection, StaticInitializerReferencesSubClassInspection, StaticPseudoFunctionalStyleMethodInspection, StreamApiMigrationInspection, StreamToLoopInspection, StringRepeatCanBeUsedInspection, StringTokenizerDelimiterInspection, SuspiciousArrayMethodCallInspection, SuspiciousCollectionsMethodCallsInspection, SuspiciousDateFormatInspection, SuspiciousListRemoveInLoopInspection, SuspiciousNameCombinationInspection, SwitchStatementsWithoutDefaultInspection, TestOnlyInspection, TextBlockBackwardMigrationInspection, TextBlockMigrationInspection, TitleCapitalizationInspection, TrivialFunctionalExpressionUsageInspection, TypeMayBeWeakenedInspection, UncheckedWarningLocalInspection, UnknownGuardInspection, UnusedReturnValueLocalInspection, UnusedSymbolLocalInspectionBase, UseBulkOperationInspection, UseCompareMethodInspection, VariableTypeCanBeExplicitInspection, WrapperTypeMayBePrimitiveInspection, WrongPackageStatementInspection

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

Constructor and Description
AbstractBaseJavaLocalInspectionTool()

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 method, InspectionManager manager, boolean isOnTheFly) Override this to report problems at method level.

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, 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

AbstractBaseJavaLocalInspectionTool

public AbstractBaseJavaLocalInspectionTool()

Method Detail

checkMethod

public ProblemDescriptor [] checkMethod(PsiMethod 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(PsiClass 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(PsiField 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