Package com.intellij.codeInspection.localCanBeFinal

Class LocalCanBeFinal

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.localCanBeFinal.LocalCanBeFinal

All Implemented Interfaces:

BatchSuppressableTool, CleanupLocalInspectionTool

public class LocalCanBeFinal
extends AbstractBaseJavaLocalInspectionTool
implements CleanupLocalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
boolean	REPORT_CATCH_PARAMETERS
boolean	REPORT_FOREACH_PARAMETERS
boolean	REPORT_IMPLICIT_FINALS
boolean	REPORT_PARAMETERS
boolean	REPORT_VARIABLES
static java.lang.String	SHORT_NAME

Fields inherited from class com.intellij.codeInspection.LocalInspectionTool

EMPTY_ARRAY, VALID_ID_PATTERN

Fields inherited from class com.intellij.codeInspection.InspectionProfileEntry

myNameProvider

Constructor Summary

Constructors

Constructor and Description
LocalCanBeFinal()

Method Summary

Modifier and Type	Method and Description
ProblemDescriptor[]	checkClass(PsiClass aClass, InspectionManager manager, boolean isOnTheFly) Override this to report problems at class level.
ProblemDescriptor[]	checkMethod(PsiMethod method, InspectionManager manager, boolean isOnTheFly) Override this to report problems at method level.
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
java.lang.String	getGroupDisplayName()
java.lang.String	getShortName() DO NOT OVERRIDE this method.
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

buildVisitor, checkField

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, checkFile, getAlternativeID, getID, getProblemElement, getSuppressId, inspectionFinished, inspectionFinished, inspectionStarted, isValidID, processFile, runForWholeFile

Methods inherited from class com.intellij.codeInspection.InspectionProfileEntry

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

Methods inherited from class java.lang.Object

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

Field Detail

REPORT_VARIABLES

public boolean REPORT_VARIABLES

REPORT_PARAMETERS

public boolean REPORT_PARAMETERS

REPORT_CATCH_PARAMETERS

public boolean REPORT_CATCH_PARAMETERS

REPORT_FOREACH_PARAMETERS

public boolean REPORT_FOREACH_PARAMETERS

REPORT_IMPLICIT_FINALS

public boolean REPORT_IMPLICIT_FINALS

SHORT_NAME

public static final java.lang.String SHORT_NAME

See Also:

Constant Field Values

Constructor Detail

LocalCanBeFinal

public LocalCanBeFinal()

Method Detail

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

checkMethod

public ProblemDescriptor[] checkMethod(PsiMethod method,
                                       InspectionManager manager,
                                       boolean isOnTheFly)

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at method level.

Overrides:

checkMethod in class AbstractBaseJavaLocalInspectionTool

Parameters:

method - to check.

manager - InspectionManager to ask for ProblemDescriptors from.

isOnTheFly - true if called during on the fly editor highlighting. Called from Inspect Code action otherwise.

Returns:

null if no problems found or not applicable at method level.

checkClass

public ProblemDescriptor[] checkClass(PsiClass aClass,
                                      InspectionManager manager,
                                      boolean isOnTheFly)

Description copied from class: AbstractBaseJavaLocalInspectionTool

Override this to report problems at class level.

Overrides:

checkClass in class AbstractBaseJavaLocalInspectionTool

Parameters:

aClass - to check.

manager - InspectionManager to ask for ProblemDescriptors from.

isOnTheFly - true if called during on the fly editor highlighting. Called from Inspect Code action otherwise.

Returns:

null if no problems found or not applicable at class level.

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

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.