Package com.intellij.codeInspection

Class GlobalInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

GlobalJavaBatchInspectionTool, GlobalSimpleInspectionTool, InconsistentLanguageLevelInspection, UnnecessaryModuleDependencyInspection, UnusedDeclarationInspectionBase, UnusedLibrariesInspection

public abstract class GlobalInspectionTool
extends InspectionProfileEntry

Base class for global inspections. Global inspections work only in batch mode (when the "Analyze / Inspect Code" is invoked) and can access the complete graph of references between classes, methods and other elements in the scope selected for the analysis. Global inspections can use a shared local inspection tool for highlighting the cases that do not need global analysis in the editor by implementing getSharedLocalInspectionTool() The shared local inspection tools shares settings and documentation with the global inspection tool.

See Also:

LocalInspectionTool

Field Summary

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
GlobalInspectionTool()

Method Summary

Modifier and Type	Method and Description
CommonProblemDescriptor []	checkElement(RefEntity refEntity, AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext) Processes and reports problems for a single element of the completed reference graph.
CommonProblemDescriptor []	checkElement(RefEntity refEntity, AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor processor) Processes and reports problems for a single element of the completed reference graph.
void	compose(java.lang.StringBuilder buf, RefEntity refEntity, HTMLComposer composer) Allows additional description to refEntity problems
JobDescriptor []	getAdditionalJobs()
JobDescriptor []	getAdditionalJobs(GlobalInspectionContext context)
RefGraphAnnotator	getAnnotator(RefManager refManager) Returns the annotator which will receive callbacks while the reference graph is being built.
java.lang.String	getHint(QuickFix fix) Allows TeamCity plugin to serialize quick fixes on server in order to reconstruct them in idea
QuickFix	getQuickFix(java.lang.String hint) Allows TeamCity plugin to reconstruct quickfixes from server side data
LocalInspectionTool	getSharedLocalInspectionTool() Returns the local inspection tool used for highlighting in the editor.
protected java.lang.String	getSuppressId() Tool ID passed to InspectionSuppressor.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.
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
boolean	queryExternalUsagesRequests(InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Allows the inspection to process usages of analyzed classes outside the analysis scope.
void	runInspection(AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Runs the global inspection.
boolean	worksInBatchModeOnly() In some cases we can do highlighting in annotator or high.

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

GlobalInspectionTool

public GlobalInspectionTool()

Method Detail

getSuppressId

protected final java.lang.String getSuppressId()

Description copied from class: InspectionProfileEntry

Tool ID passed to InspectionSuppressor.

Overrides:

getSuppressId in class InspectionProfileEntry

getAnnotator

public RefGraphAnnotator getAnnotator(RefManager refManager)

Returns the annotator which will receive callbacks while the reference graph is being built. The annotator can be used to add additional markers to reference graph nodes, through calls to UserDataHolder.putUserData(com.intellij.openapi.util.Key, Object).

Parameters:

refManager - the reference graph manager instance

Returns:

the annotator instance, or null if the inspection does not need any additional markers or does not use the reference graph at all.

See Also:

isGraphNeeded()

runInspection

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

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 checkElement(RefEntity, AnalysisScope, InspectionManager, GlobalInspectionContext).

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

checkElement

public CommonProblemDescriptor [] checkElement(RefEntity refEntity,
                                               AnalysisScope scope,
                                               InspectionManager manager,
                                               GlobalInspectionContext globalContext)

Processes and reports problems for a single element of the completed reference graph.

Parameters:

refEntity - the reference graph element to check for problems.

scope - the scope on which analysis was invoked.

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

globalContext - the context for the current global inspection run.

Returns:

the problems found for the element, or null if no problems were found.

checkElement

public CommonProblemDescriptor [] checkElement(RefEntity refEntity,
                                               AnalysisScope scope,
                                               InspectionManager manager,
                                               GlobalInspectionContext globalContext,
                                               ProblemDescriptionsProcessor processor)

Processes and reports problems for a single element of the completed reference graph.

Parameters:

refEntity - the reference graph element to check for problems.

scope - the scope on which analysis was invoked.

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

globalContext - the context for the current global inspection run.

processor - the collector for problems reported by the inspection

Returns:

the problems found for the element, or null if no problems were found.

isGraphNeeded

public boolean isGraphNeeded()

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.

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.

isReadActionNeeded

public boolean isReadActionNeeded()

True by default to ensure third party plugins are not broken

Returns:

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

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

queryExternalUsagesRequests

public boolean queryExternalUsagesRequests(InspectionManager manager,
                                           GlobalInspectionContext globalContext,
                                           ProblemDescriptionsProcessor problemDescriptionsProcessor)

Allows the inspection to process usages of analyzed classes outside the analysis scope. This method is called after the reference graph has been built and after the runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor) method has collected the list of problems for the current scope. In order to save time when multiple inspections need to process usages of the same classes and methods, usage searches are not performed directly, but instead are queued for batch processing through GlobalJavaInspectionContext.enqueueClassUsagesProcessor(com.intellij.codeInspection.reference.RefClass, com.intellij.codeInspection.GlobalJavaInspectionContext.UsagesProcessor) and similar methods. The method can add new problems to problemDescriptionsProcessor or remove some of the problems collected by runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor) by calling ProblemDescriptionsProcessor.ignoreElement(RefEntity).

Parameters:

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.

Returns:

true if a repeated call to this method is required after the queued usage processors have completed work, false otherwise.

getQuickFix

public QuickFix getQuickFix(java.lang.String hint)

Allows TeamCity plugin to reconstruct quickfixes from server side data

Parameters:

hint - a hint to distinguish different quick fixes for one problem

Returns:

quickfix to be shown in editor when server side inspections are enabled

getHint

public java.lang.String getHint(QuickFix fix)

Allows TeamCity plugin to serialize quick fixes on server in order to reconstruct them in idea

Parameters:

fix - fix to be serialized

Returns:

hint to be stored on server

compose

public void compose(java.lang.StringBuilder buf,
                    RefEntity refEntity,
                    HTMLComposer composer)

Allows additional description to refEntity problems

Parameters:

buf - page content with problem description

refEntity - entity to describe

composer - provides sample api to compose html

getAdditionalJobs

public JobDescriptor [] getAdditionalJobs()

Returns:

JobDescriptors array to show inspection progress correctly. TotalAmount should be set (e.g. in runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor)) ProgressIndicator should progress with GlobalInspectionContext.incrementJobDoneAmount(JobDescriptor, String)

getAdditionalJobs

public JobDescriptor [] getAdditionalJobs(GlobalInspectionContext context)

Returns:

JobDescriptors array to show inspection progress correctly. TotalAmount should be set (e.g. in runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor)) ProgressIndicator should progress with GlobalInspectionContext.incrementJobDoneAmount(JobDescriptor, String)

worksInBatchModeOnly

public boolean worksInBatchModeOnly()

In some cases we can do highlighting in annotator or high. visitor based on global inspection or use a shared local inspection tool

getSharedLocalInspectionTool

public LocalInspectionTool getSharedLocalInspectionTool()

Returns the local inspection tool used for highlighting in the editor. Meant for global inspections which have a local component. The local inspection tool is not required to report on the exact same problems, and naturally can't use global analysis. The local inspection tool is not used in batch mode. For example a global inspection that reports a package could have a local inspection tool which highlights the package statement in a file.