Package com.intellij.codeInspection

Class GlobalJavaBatchInspectionTool

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.GlobalJavaBatchInspectionTool

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

BaseGlobalInspection, BooleanMethodIsAlwaysInvertedInspection, CanBeFinalInspection, EmptyMethodInspection, Java9RedundantRequiresStatementInspection, RedundantThrowsDeclarationInspection, SameParameterValueInspection, SameReturnValueInspection, UnusedReturnValue, VisibilityInspection

public abstract class GlobalJavaBatchInspectionTool
extends GlobalInspectionTool

Field Summary

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
GlobalJavaBatchInspectionTool()

Method Summary

Modifier and Type	Method and Description
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.
protected boolean	queryExternalUsagesRequests(RefManager manager, GlobalJavaInspectionContext globalContext, ProblemDescriptionsProcessor processor)

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, checkElement, compose, getAdditionalJobs, getAdditionalJobs, getAnnotator, getHint, getQuickFix, getSharedLocalInspectionTool, getSuppressId, isEnabledByDefault, isGraphNeeded, runInspection, 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

GlobalJavaBatchInspectionTool

public GlobalJavaBatchInspectionTool()

Method Detail

queryExternalUsagesRequests

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

Description copied from class: GlobalInspectionTool

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 GlobalInspectionTool.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 GlobalInspectionTool.runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor) by calling ProblemDescriptionsProcessor.ignoreElement(RefEntity).

Overrides:

queryExternalUsagesRequests in class GlobalInspectionTool

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.

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

queryExternalUsagesRequests

protected boolean queryExternalUsagesRequests(RefManager manager,
                                              GlobalJavaInspectionContext globalContext,
                                              ProblemDescriptionsProcessor processor)