Package com.intellij.codeInspection.suspiciousNameCombination

Class SuspiciousNameCombinationInspection

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

com.intellij.codeInspection.suspiciousNameCombination.SuspiciousNameCombinationInspection

All Implemented Interfaces:

BatchSuppressableTool

public class SuspiciousNameCombinationInspection
extends AbstractBaseJavaLocalInspectionTool

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<java.lang.String>	myNameGroups

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

Method Summary

Modifier and Type	Method and Description
void	addNameGroup(java.lang.String group)
PsiElementVisitor	buildVisitor(ProblemsHolder holder, boolean isOnTheFly) Override the method to provide your own inspection visitor.
protected void	clearNameGroups()
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.
boolean	isEnabledByDefault() DO NOT OVERRIDE this method.
void	readSettings(Element node) Read in settings from XML config.
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.AbstractBaseJavaLocalInspectionTool

checkClass, checkField, checkMethod

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, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions

Methods inherited from class java.lang.Object

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

Field Detail

myNameGroups

protected final java.util.List<java.lang.String> myNameGroups

Constructor Detail

SuspiciousNameCombinationInspection

public SuspiciousNameCombinationInspection()

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.

isEnabledByDefault

public boolean isEnabledByDefault()

Description copied from class: InspectionProfileEntry

DO NOT OVERRIDE this method.

Overrides:

isEnabledByDefault in class InspectionProfileEntry

See Also:

InspectionEP.enabledByDefault

clearNameGroups

protected void clearNameGroups()

addNameGroup

public void addNameGroup(java.lang.String group)

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

buildVisitor

public PsiElementVisitor buildVisitor(ProblemsHolder holder,
                                      boolean isOnTheFly)

Description copied from class: LocalInspectionTool

Override the method to provide your own inspection visitor. Created visitor must not be recursive (e.g. it must not inherit PsiRecursiveElementVisitor) since it will be fed with every element in the file anyway. Visitor created must be thread-safe since it might be called on several elements concurrently.

Overrides:

buildVisitor in class AbstractBaseJavaLocalInspectionTool

Parameters:

holder - where visitor will register problems found.

isOnTheFly - true if inspection was run in non-batch mode

Returns:

not-null visitor for this inspection.

See Also:

PsiRecursiveVisitor

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