Package com.intellij.codeInspection.canBeFinal

Class CanBeFinalInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.GlobalInspectionTool

com.intellij.codeInspection.GlobalJavaBatchInspectionTool

com.intellij.codeInspection.canBeFinal.CanBeFinalInspection

All Implemented Interfaces:

BatchSuppressableTool

public class CanBeFinalInspection
extends GlobalJavaBatchInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	REPORT_CLASSES
boolean	REPORT_FIELDS
boolean	REPORT_METHODS
static java.lang.String	SHORT_NAME

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
CanBeFinalInspection()

Method Summary

Modifier and Type	Method and Description
CommonProblemDescriptor []	checkElement(RefEntity refEntity, AnalysisScope scope, InspectionManager manager, GlobalInspectionContext globalContext, ProblemDescriptionsProcessor processor) Processes and reports problems for a single element of the completed reference graph.
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()
QuickFix<ProblemDescriptor>	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	isReportClasses()
boolean	isReportFields()
boolean	isReportMethods()
protected boolean	queryExternalUsagesRequests(RefManager manager, GlobalJavaInspectionContext globalContext, ProblemDescriptionsProcessor problemsProcessor)

Methods inherited from class com.intellij.codeInspection.GlobalJavaBatchInspectionTool

isReadActionNeeded, queryExternalUsagesRequests

Methods inherited from class com.intellij.codeInspection.GlobalInspectionTool

checkElement, compose, getAdditionalJobs, getAdditionalJobs, getHint, getSharedLocalInspectionTool, getSuppressId, isEnabledByDefault, isGraphNeeded, runInspection, 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

REPORT_CLASSES

public boolean REPORT_CLASSES

REPORT_METHODS

public boolean REPORT_METHODS

REPORT_FIELDS

public boolean REPORT_FIELDS

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

CanBeFinalInspection

public CanBeFinalInspection()

Method Detail

isReportClasses

public boolean isReportClasses()

isReportMethods

public boolean isReportMethods()

isReportFields

public boolean isReportFields()

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

checkElement

public CommonProblemDescriptor [] checkElement(RefEntity refEntity,
                                               AnalysisScope scope,
                                               InspectionManager manager,
                                               GlobalInspectionContext globalContext,
                                               ProblemDescriptionsProcessor processor)

Description copied from class: GlobalInspectionTool

Processes and reports problems for a single element of the completed reference graph.

Overrides:

checkElement in class GlobalInspectionTool

Parameters:

refEntity - the reference graph element to check for problems.

scope - the scope on which analysis was invoked.

manager - the inspection manager instance for the project on which the inspection was run.

globalContext - the context for the current global inspection run.

processor - the collector for problems reported by the inspection

Returns:

the problems found for the element, or null if no problems were found.

queryExternalUsagesRequests

protected boolean queryExternalUsagesRequests(RefManager manager,
                                              GlobalJavaInspectionContext globalContext,
                                              ProblemDescriptionsProcessor problemsProcessor)

Overrides:

queryExternalUsagesRequests in class GlobalJavaBatchInspectionTool

getQuickFix

public QuickFix<ProblemDescriptor> 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

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