Package com.intellij.codeInspection.deadCode

Class UnusedDeclarationInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.deadCode.UnusedDeclarationInspectionBase

com.intellij.codeInspection.deadCode.UnusedDeclarationInspection

All Implemented Interfaces:

BatchSuppressableTool

public class UnusedDeclarationInspection
extends UnusedDeclarationInspectionBase

Field Summary

Fields inherited from class com.intellij.codeInspection.deadCode.UnusedDeclarationInspectionBase

ADD_APPLET_TO_ENTRIES, ADD_MAINS_TO_ENTRIES, ADD_NONJAVA_TO_ENTRIES, ADD_SERVLET_TO_ENTRIES, ALTERNATIVE_ID, SHORT_NAME

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
UnusedDeclarationInspection()
UnusedDeclarationInspection(boolean enabledInEditor)

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
protected UnusedSymbolLocalInspectionBase	createUnusedSymbolLocalInspection()
java.lang.String	getAlternativeID() For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage
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
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.

Methods inherited from class com.intellij.codeInspection.deadCode.UnusedDeclarationInspectionBase

findUnusedDeclarationInspection, getAdditionalJobs, getDisplayNameText, getExtensions, getGroupDisplayName, getSharedLocalInspectionTool, getShortName, isDeclaredAsEntryPoint, isEntryPoint, isEntryPoint, isGlobalEnabledInEditor, isReadActionNeeded, isTestEntryPoints, readSettings, setTestEntryPoints, writeSettings, writeUnusedDeclarationSettings

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, checkElement, compose, getAdditionalJobs, getSuppressId, isEnabledByDefault, isGraphNeeded, worksInBatchModeOnly

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, 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

Constructor Detail

UnusedDeclarationInspection

public UnusedDeclarationInspection()

UnusedDeclarationInspection

public UnusedDeclarationInspection(boolean enabledInEditor)

Method Detail

getAlternativeID

public java.lang.String getAlternativeID()

Description copied from class: InspectionProfileEntry

For global tools read-only, for local tools would be used instead getID for modules with alternative classpath storage

Overrides:

getAlternativeID in class InspectionProfileEntry

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 UnusedDeclarationInspectionBase

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

getAnnotator

public RefGraphAnnotator getAnnotator(RefManager refManager)

Description copied from class: GlobalInspectionTool

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).

Overrides:

getAnnotator in class GlobalInspectionTool

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:

GlobalInspectionTool.isGraphNeeded()

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 UnusedDeclarationInspectionBase

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.

getHint

public java.lang.String getHint(QuickFix fix)

Description copied from class: GlobalInspectionTool

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

Overrides:

getHint in class GlobalInspectionTool

Parameters:

fix - fix to be serialized

Returns:

hint to be stored on server

getQuickFix

public QuickFix getQuickFix(java.lang.String hint)

Description copied from class: GlobalInspectionTool

Allows TeamCity plugin to reconstruct quickfixes from server side data

Overrides:

getQuickFix in class GlobalInspectionTool

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

createUnusedSymbolLocalInspection

protected UnusedSymbolLocalInspectionBase createUnusedSymbolLocalInspection()

Overrides:

createUnusedSymbolLocalInspection in class UnusedDeclarationInspectionBase

createOptionsPanel

public javax.swing.JComponent createOptionsPanel()

Description copied from class: InspectionProfileEntry

This method is called each time UI is shown.

Overrides:

createOptionsPanel in class InspectionProfileEntry

Returns:

null if no UI options required.