Package com.intellij.codeInspection.deadCode

Class UnusedDeclarationInspectionBase

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.deadCode.UnusedDeclarationInspectionBase

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

DummyEntryPointsTool, UnusedDeclarationInspection

public class UnusedDeclarationInspectionBase
extends GlobalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	ADD_APPLET_TO_ENTRIES
boolean	ADD_MAINS_TO_ENTRIES
boolean	ADD_NONJAVA_TO_ENTRIES
boolean	ADD_SERVLET_TO_ENTRIES
static java.lang.String	ALTERNATIVE_ID
static java.lang.String	SHORT_NAME

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
UnusedDeclarationInspectionBase()
UnusedDeclarationInspectionBase(boolean enabledInEditor)

Method Summary

Modifier and Type	Method and Description
protected UnusedSymbolLocalInspectionBase	createUnusedSymbolLocalInspection()
static UnusedDeclarationInspectionBase	findUnusedDeclarationInspection(PsiElement element)
JobDescriptor []	getAdditionalJobs(GlobalInspectionContext context)
static java.lang.String	getDisplayNameText()
java.util.List<EntryPoint>	getExtensions()
java.lang.String	getGroupDisplayName()
UnusedSymbolLocalInspectionBase	getSharedLocalInspectionTool() Returns the local inspection tool used for highlighting in the editor.
java.lang.String	getShortName() DO NOT OVERRIDE this method.
static boolean	isDeclaredAsEntryPoint(PsiElement method)
boolean	isEntryPoint(PsiElement element)
boolean	isEntryPoint(RefElement owner)
boolean	isGlobalEnabledInEditor()
boolean	isReadActionNeeded() True by default to ensure third party plugins are not broken
boolean	isTestEntryPoints()
boolean	queryExternalUsagesRequests(InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Allows the inspection to process usages of analyzed classes outside the analysis scope.
void	readSettings(Element node) Read in settings from XML config.
void	runInspection(AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Runs the global inspection.
void	setTestEntryPoints(boolean testEntryPoints)
void	writeSettings(Element node) Store current settings in XML config.
protected void	writeUnusedDeclarationSettings(Element node)

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, checkElement, compose, getAdditionalJobs, getAnnotator, getHint, getQuickFix, getSuppressId, isEnabledByDefault, isGraphNeeded, worksInBatchModeOnly

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, createOptionsPanel, getAlternativeID, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getStaticDescription, getSuppressors, initialize, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions

Methods inherited from class java.lang.Object

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

Field Detail

ADD_MAINS_TO_ENTRIES

public boolean ADD_MAINS_TO_ENTRIES

ADD_APPLET_TO_ENTRIES

public boolean ADD_APPLET_TO_ENTRIES

ADD_SERVLET_TO_ENTRIES

public boolean ADD_SERVLET_TO_ENTRIES

ADD_NONJAVA_TO_ENTRIES

public boolean ADD_NONJAVA_TO_ENTRIES

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

ALTERNATIVE_ID

public static final java.lang.String ALTERNATIVE_ID

See Also:

Constant Field Values

Constructor Detail

UnusedDeclarationInspectionBase

public UnusedDeclarationInspectionBase()

UnusedDeclarationInspectionBase

public UnusedDeclarationInspectionBase(boolean enabledInEditor)

Method Detail

createUnusedSymbolLocalInspection

protected UnusedSymbolLocalInspectionBase createUnusedSymbolLocalInspection()

getSharedLocalInspectionTool

public UnusedSymbolLocalInspectionBase getSharedLocalInspectionTool()

Description copied from class: GlobalInspectionTool

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.

Overrides:

getSharedLocalInspectionTool in class GlobalInspectionTool

isTestEntryPoints

public boolean isTestEntryPoints()

setTestEntryPoints

public void setTestEntryPoints(boolean testEntryPoints)

getGroupDisplayName

public java.lang.String getGroupDisplayName()

Overrides:

getGroupDisplayName in class InspectionProfileEntry

See Also:

InspectionEP.groupDisplayName, InspectionEP.groupKey, InspectionEP.groupBundle

getShortName

public java.lang.String getShortName()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

getShortName in class InspectionProfileEntry

See Also:

InspectionEP.shortName

readSettings

public void readSettings(Element node)
                  throws InvalidDataException

Description copied from class: InspectionProfileEntry

Read in settings from XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

readSettings in class InspectionProfileEntry

Parameters:

node - to read settings from.

Throws:

InvalidDataException - if the loaded data was not valid.

writeSettings

public void writeSettings(Element node)
                   throws WriteExternalException

Description copied from class: InspectionProfileEntry

Store current settings in XML config. Default implementation uses XmlSerializer so you may use public fields (like int TOOL_OPTION) and bean-style getters/setters (like int getToolOption(), void setToolOption(int)) to store your options.

Overrides:

writeSettings in class InspectionProfileEntry

Parameters:

node - to store settings to.

Throws:

WriteExternalException

writeUnusedDeclarationSettings

protected void writeUnusedDeclarationSettings(Element node)
                                       throws WriteExternalException

Throws:

WriteExternalException

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

runInspection

public 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

isEntryPoint

public boolean isEntryPoint(RefElement owner)

isEntryPoint

public boolean isEntryPoint(PsiElement element)

isGlobalEnabledInEditor

public boolean isGlobalEnabledInEditor()

findUnusedDeclarationInspection

public static UnusedDeclarationInspectionBase findUnusedDeclarationInspection(PsiElement element)

isDeclaredAsEntryPoint

public static boolean isDeclaredAsEntryPoint(PsiElement method)

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.

getAdditionalJobs

public JobDescriptor [] getAdditionalJobs(GlobalInspectionContext context)

Overrides:

getAdditionalJobs in class GlobalInspectionTool

Returns:

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

getExtensions

public java.util.List<EntryPoint> getExtensions()

getDisplayNameText

public static java.lang.String getDisplayNameText()