Package com.intellij.codeInspection.unusedLibraries

Class UnusedLibrariesInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.unusedLibraries.UnusedLibrariesInspection

All Implemented Interfaces:

BatchSuppressableTool

public class UnusedLibrariesInspection
extends GlobalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	IGNORE_LIBRARY_PARTS

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
UnusedLibrariesInspection()

Method Summary

Modifier and Type	Method and Description
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
RefGraphAnnotator	getAnnotator(RefManager refManager) Returns the annotator which will receive callbacks while the reference graph is being built.
java.lang.String	getGroupDisplayName()
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
java.lang.String	getShortName() DO NOT OVERRIDE this method.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.
boolean	isReadActionNeeded() True by default to ensure third party plugins are not broken
void	runInspection(AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor problemDescriptionsProcessor) Runs the global inspection.

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, checkElement, compose, getAdditionalJobs, getAdditionalJobs, getSharedLocalInspectionTool, getSuppressId, isGraphNeeded, queryExternalUsagesRequests, worksInBatchModeOnly

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

cleanup, getAlternativeID, getBatchSuppressActions, getBlackList, getDefaultLevel, getDescriptionContextClass, getDescriptionFileName, getDisplayName, getGeneralGroupName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, 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

Field Detail

IGNORE_LIBRARY_PARTS

public boolean IGNORE_LIBRARY_PARTS

Constructor Detail

UnusedLibrariesInspection

public UnusedLibrariesInspection()

Method Detail

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.

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

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

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class GlobalInspectionTool

See Also:

InspectionEP.enabledByDefault

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

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

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