Package com.intellij.codeInspection.ex

Class GlobalInspectionContextBase

java.lang.Object

com.intellij.openapi.util.UserDataHolderBase

com.intellij.codeInspection.ex.GlobalInspectionContextBase

All Implemented Interfaces:

GlobalInspectionContext, UserDataHolder, UserDataHolderEx

Direct Known Subclasses:

GlobalInspectionContextEx

public class GlobalInspectionContextBase
extends UserDataHolderBase
implements GlobalInspectionContext

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LOCAL_TOOL_ATTRIBUTE
protected java.util.Map<Key<?>,GlobalInspectionContextExtension<?>>	myExtensions
protected ProgressIndicator	myProgressIndicator
static java.lang.String	PROBLEMS_TAG_NAME

Constructor Summary

Constructors

Constructor and Description
GlobalInspectionContextBase(Project project)

Method Summary

Modifier and Type	Method and Description
static void	assertUnderDaemonProgress()
protected void	canceled()
void	cleanup()
static void	cleanupElements(Project project, java.lang.Runnable runnable, java.util.List<? extends SmartPsiElementPointer<PsiElement>> elements)
static void	cleanupElements(Project project, java.lang.Runnable runnable, java.util.function.Predicate<? super ProblemDescriptor> shouldApplyFix, PsiElement... scope)
static void	cleanupElements(Project project, java.lang.Runnable runnable, PsiElement... scope)
void	close(boolean noSuspiciousCodeFound)
void	codeCleanup(AnalysisScope scope, InspectionProfile profile, java.lang.String commandName, java.lang.Runnable postRunnable, boolean modal)
void	codeCleanup(AnalysisScope scope, InspectionProfile profile, java.lang.String commandName, java.lang.Runnable postRunnable, boolean modal, java.util.function.Predicate<? super ProblemDescriptor> shouldApplyFix)
protected PerformInBackgroundOption	createOption()
void	doInspections(AnalysisScope scope)
InspectionProfileImpl	getCurrentProfile()
AnalysisScope	getCurrentScope()
<T> T	getExtension(Key<T> key)
Project	getProject()
RefManager	getRefManager() Returns the reference graph for the global inspection run.
StdJobDescriptors	getStdJobDescriptors()
java.util.Map<java.lang.String,Tools>	getTools()
java.util.List<Tools>	getUsedTools()
void	incrementJobDoneAmount(JobDescriptor job, java.lang.String message)
void	initializeTools(java.util.List<Tools> outGlobalTools, java.util.List<Tools> outLocalTools, java.util.List<? super Tools> outGlobalSimpleTools)
boolean	isSuppressed(PsiElement element, java.lang.String id) Checks if the inspection with the specified ID is suppressed for the specified PSI element.
boolean	isToCheckFile(PsiFile file, InspectionProfileEntry tool)
boolean	isToCheckMember(RefElement owner, InspectionProfileEntry tool)
protected void	launchInspections(AnalysisScope scope)
static void	modalCodeCleanup(Project project, AnalysisScope scope, java.lang.Runnable runnable)
protected void	notifyInspectionsFinished(AnalysisScope scope)
void	performInspectionsWithProgress(AnalysisScope scope, boolean runGlobalToolsOnly, boolean isOfflineInspections)
protected void	runTools(AnalysisScope scope, boolean runGlobalToolsOnly, boolean isOfflineInspections)
void	setCurrentScope(AnalysisScope currentScope)
void	setExternalProfile(InspectionProfileImpl profile)
void	setRerunAction(java.lang.Runnable action)
boolean	shouldCheck(RefEntity entity, GlobalInspectionTool tool) Checks if the inspection is suppressed for the specified reference graph node.

Methods inherited from class com.intellij.openapi.util.UserDataHolderBase

changeUserMap, clearUserData, clone, copyCopyableDataTo, copyUserDataTo, getCopyableUserData, getUserData, getUserDataString, getUserMap, isUserDataEmpty, putCopyableUserData, putUserData, putUserDataIfAbsent, replace, setUserMap

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getUserData, putUserData

Field Detail

myProgressIndicator

protected ProgressIndicator myProgressIndicator

myExtensions

protected final java.util.Map<Key<?>,GlobalInspectionContextExtension<?>> myExtensions

PROBLEMS_TAG_NAME

public static final java.lang.String PROBLEMS_TAG_NAME

See Also:

Constant Field Values

LOCAL_TOOL_ATTRIBUTE

public static final java.lang.String LOCAL_TOOL_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

GlobalInspectionContextBase

public GlobalInspectionContextBase(Project project)

Method Detail

getCurrentScope

public AnalysisScope getCurrentScope()

getProject

public Project getProject()

Specified by:

getProject in interface GlobalInspectionContext

getExtension

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

Specified by:

getExtension in interface GlobalInspectionContext

getCurrentProfile

public InspectionProfileImpl getCurrentProfile()

shouldCheck

public boolean shouldCheck(RefEntity entity,
                           GlobalInspectionTool tool)

Description copied from interface: GlobalInspectionContext

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)

Specified by:

shouldCheck in interface GlobalInspectionContext

Parameters:

entity - the reference graph node to check.

tool - the inspection to check.

Returns:

true if the inspection is suppressed, false otherwise.

isSuppressed

public boolean isSuppressed(PsiElement element,
                            java.lang.String id)

Description copied from interface: GlobalInspectionContext

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

Specified by:

isSuppressed in interface GlobalInspectionContext

Parameters:

element - the PSI element to check.

id - the ID of the inspection to check.

Returns:

true if the inspection is suppressed, false otherwise.

setCurrentScope

public void setCurrentScope(AnalysisScope currentScope)

setRerunAction

public void setRerunAction(java.lang.Runnable action)

doInspections

public void doInspections(AnalysisScope scope)

getRefManager

public RefManager getRefManager()

Description copied from interface: GlobalInspectionContext

Returns the reference graph for the global inspection run.

Specified by:

getRefManager in interface GlobalInspectionContext

Returns:

the reference graph instance.

isToCheckMember

public boolean isToCheckMember(RefElement owner,
                               InspectionProfileEntry tool)

isToCheckFile

public boolean isToCheckFile(PsiFile file,
                             InspectionProfileEntry tool)

launchInspections

protected void launchInspections(AnalysisScope scope)

createOption

protected PerformInBackgroundOption createOption()

notifyInspectionsFinished

protected void notifyInspectionsFinished(AnalysisScope scope)

performInspectionsWithProgress

public void performInspectionsWithProgress(AnalysisScope scope,
                                           boolean runGlobalToolsOnly,
                                           boolean isOfflineInspections)

canceled

protected void canceled()

runTools

protected void runTools(AnalysisScope scope,
                        boolean runGlobalToolsOnly,
                        boolean isOfflineInspections)

initializeTools

public void initializeTools(java.util.List<Tools> outGlobalTools,
                            java.util.List<Tools> outLocalTools,
                            java.util.List<? super Tools> outGlobalSimpleTools)

getUsedTools

public java.util.List<Tools> getUsedTools()

getTools

public java.util.Map<java.lang.String,Tools> getTools()

codeCleanup

public void codeCleanup(AnalysisScope scope,
                        InspectionProfile profile,
                        java.lang.String commandName,
                        java.lang.Runnable postRunnable,
                        boolean modal,
                        java.util.function.Predicate<? super ProblemDescriptor> shouldApplyFix)

codeCleanup

public void codeCleanup(AnalysisScope scope,
                        InspectionProfile profile,
                        java.lang.String commandName,
                        java.lang.Runnable postRunnable,
                        boolean modal)

modalCodeCleanup

public static void modalCodeCleanup(Project project,
                                    AnalysisScope scope,
                                    java.lang.Runnable runnable)

cleanupElements

public static void cleanupElements(Project project,
                                   java.lang.Runnable runnable,
                                   PsiElement... scope)

cleanupElements

public static void cleanupElements(Project project,
                                   java.lang.Runnable runnable,
                                   java.util.function.Predicate<? super ProblemDescriptor> shouldApplyFix,
                                   PsiElement... scope)

cleanupElements

public static void cleanupElements(Project project,
                                   java.lang.Runnable runnable,
                                   java.util.List<? extends SmartPsiElementPointer<PsiElement>> elements)

close

public void close(boolean noSuspiciousCodeFound)

cleanup

public void cleanup()

Specified by:

cleanup in interface GlobalInspectionContext

incrementJobDoneAmount

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

Specified by:

incrementJobDoneAmount in interface GlobalInspectionContext

setExternalProfile

public void setExternalProfile(InspectionProfileImpl profile)

getStdJobDescriptors

public StdJobDescriptors getStdJobDescriptors()

Specified by:

getStdJobDescriptors in interface GlobalInspectionContext

assertUnderDaemonProgress

public static void assertUnderDaemonProgress()