Package com.intellij.codeInspection

Interface GlobalInspectionContext

All Superinterfaces:

UserDataHolder

All Known Implementing Classes:

GlobalInspectionContextBase, GlobalInspectionContextEx, GlobalInspectionContextImpl

public interface GlobalInspectionContext
extends UserDataHolder

The context for a global inspection run. Provides access to the reference graph and allows to enqueue external usage processing.

See Also:

GlobalInspectionTool.runInspection(AnalysisScope, InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor), GlobalInspectionTool.queryExternalUsagesRequests(InspectionManager, GlobalInspectionContext, ProblemDescriptionsProcessor)

Method Summary

Modifier and Type	Method and Description
void	cleanup()
<T> T	getExtension(Key<T> key)
Project	getProject()
RefManager	getRefManager() Returns the reference graph for the global inspection run.
StdJobDescriptors	getStdJobDescriptors()
void	incrementJobDoneAmount(JobDescriptor job, java.lang.String message)
boolean	isSuppressed(PsiElement element, java.lang.String inspectionToolId) Checks if the inspection with the specified ID is suppressed for the specified PSI element.
boolean	shouldCheck(RefEntity entity, GlobalInspectionTool tool) Checks if the inspection is suppressed for the specified reference graph node.

Methods inherited from interface com.intellij.openapi.util.UserDataHolder

getUserData, putUserData

Method Detail

getRefManager

RefManager getRefManager()

Returns the reference graph for the global inspection run.

Returns:

the reference graph instance.

shouldCheck

boolean shouldCheck(RefEntity entity,
                    GlobalInspectionTool tool)

Checks if the inspection is suppressed for the specified reference graph node. Should not be called manually in normal case. You need to check suppressions only when you use GlobalInspectionTool.runInspection(com.intellij.analysis.AnalysisScope, com.intellij.codeInspection.InspectionManager, com.intellij.codeInspection.GlobalInspectionContext, com.intellij.codeInspection.ProblemDescriptionsProcessor)

Parameters:

entity - the reference graph node to check.

tool - the inspection to check.

Returns:

true if the inspection is suppressed, false otherwise.

isSuppressed

boolean isSuppressed(PsiElement element,
                     java.lang.String inspectionToolId)

Checks if the inspection with the specified ID is suppressed for the specified PSI element.

Parameters:

element - the PSI element to check.

inspectionToolId - the ID of the inspection to check.

Returns:

true if the inspection is suppressed, false otherwise.

getProject

Project getProject()

getExtension

<T> T getExtension(Key<T> key)

incrementJobDoneAmount

void incrementJobDoneAmount(JobDescriptor job,
                            java.lang.String message)

getStdJobDescriptors

StdJobDescriptors getStdJobDescriptors()

cleanup

void cleanup()