Package com.intellij.codeInspection

Class GlobalSimpleInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.GlobalSimpleInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

DefaultHighlightVisitorBasedInspection, DuplicatePropertyInspection, InconsistentResourceBundleInspection, RedundantSuppressInspection, UnusedImportInspection, XmlHighlightVisitorBasedInspection

public abstract class GlobalSimpleInspectionTool
extends GlobalInspectionTool

Global inspection tool which doesn't need the graph and, therefore, can be run on per-file basis concurrently. Basically it is a local inspection tool which cannot be selected in the inspection profile to be run on-the-fly.

Field Summary

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
GlobalSimpleInspectionTool()

Method Summary

Modifier and Type	Method and Description
abstract void	checkFile(PsiFile file, InspectionManager manager, ProblemsHolder problemsHolder, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor)
void	inspectionFinished(InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor)
void	inspectionStarted(InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor)
boolean	isGraphNeeded() Checks if this inspection requires building of the reference graph.
boolean	isReadActionNeeded() True by default to ensure third party plugins are not broken
void	runInspection(AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Runs the global inspection.

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, checkElement, compose, getAdditionalJobs, getAdditionalJobs, getAnnotator, getHint, getQuickFix, getSharedLocalInspectionTool, getSuppressId, isEnabledByDefault, queryExternalUsagesRequests, worksInBatchModeOnly

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, createOptionsPanel, getAlternativeID, 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

GlobalSimpleInspectionTool

public GlobalSimpleInspectionTool()

Method Detail

inspectionStarted

public void inspectionStarted(InspectionManager manager,
                              GlobalInspectionContext globalContext,
                              ProblemDescriptionsProcessor problemDescriptionsProcessor)

inspectionFinished

public void inspectionFinished(InspectionManager manager,
                               GlobalInspectionContext globalContext,
                               ProblemDescriptionsProcessor problemDescriptionsProcessor)

checkFile

public abstract void checkFile(PsiFile file,
                               InspectionManager manager,
                               ProblemsHolder problemsHolder,
                               GlobalInspectionContext globalContext,
                               ProblemDescriptionsProcessor problemDescriptionsProcessor)

runInspection

public final void runInspection(AnalysisScope scope,
                                InspectionManager manager,
                                GlobalInspectionContext globalContext,
                                ProblemDescriptionsProcessor problemDescriptionsProcessor)

Description copied from class: GlobalInspectionTool

Runs the global inspection. If building of the reference graph was requested by one of the global inspection tools, this method is called after the graph has been built and before the external usages are processed. The default implementation of the method passes each node of the graph for processing to GlobalInspectionTool.checkElement(RefEntity, AnalysisScope, InspectionManager, GlobalInspectionContext).

Overrides:

runInspection in class GlobalInspectionTool

Parameters:

scope - the scope on which the inspection was run.

manager - the inspection manager instance for the project on which the inspection was run.

globalContext - the context for the current global inspection run.

problemDescriptionsProcessor - the collector for problems reported by the inspection

isReadActionNeeded

public boolean isReadActionNeeded()

Description copied from class: GlobalInspectionTool

True by default to ensure third party plugins are not broken

Overrides:

isReadActionNeeded in class GlobalInspectionTool

Returns:

true if inspection should be started (GlobalInspectionTool.runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor)) in ReadAction, false if ReadAction is taken by inspection itself

isGraphNeeded

public final boolean isGraphNeeded()

Description copied from class: GlobalInspectionTool

Checks if this inspection requires building of the reference graph. The reference graph is built if at least one of the global inspection has requested that.

Overrides:

isGraphNeeded in class GlobalInspectionTool

Returns:

true if the reference graph is required, false if the inspection does not use a reference graph (refEntities) and uses some other APIs for its processing.