Package com.intellij.codeInspection.naming

Class AbstractNamingConventionInspection<T extends PsiNameIdentifierOwner>

java.lang.Object

com.intellij.codeInspection.InspectionProfileEntry

com.intellij.codeInspection.LocalInspectionTool

com.intellij.codeInspection.naming.AbstractNamingConventionInspection<T>

All Implemented Interfaces:

BatchSuppressableTool

Direct Known Subclasses:

FieldNamingConventionInspection, NewClassNamingConventionInspection, NewGroovyClassNamingConventionInspection, NewMethodNamingConventionInspection

public abstract class AbstractNamingConventionInspection<T extends PsiNameIdentifierOwner>
extends LocalInspectionTool

Abstract class for naming convention inspections. Base inspection expects NamingConvention extensions which are processed one by one, the first which returns true from NamingConvention.isApplicable(PsiNameIdentifierOwner), wins and provides bean to check the member name. Provide createRenameFix() to register rename fix. Register AbstractNamingConventionMerger to provide settings migration from multiple inspections to compound one

Field Summary

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

Modifier	Constructor and Description
protected	AbstractNamingConventionInspection(java.lang.Iterable<NamingConvention<T>> extensions, java.lang.String defaultConventionShortName)

Method Summary

Modifier and Type	Method and Description
protected void	checkName(T member, java.util.function.Consumer<? super java.lang.String> errorRegister)
protected void	checkName(T member, java.lang.String name, ProblemsHolder holder)
protected java.lang.String	createErrorMessage(java.lang.String name, java.lang.String shortName)
javax.swing.JComponent	createOptionsPanel() This method is called each time UI is shown.
protected abstract LocalQuickFix	createRenameFix()
NamingConventionBean	getNamingConventionBean(java.lang.String shortName)
java.util.Set<java.lang.String>	getOldToolNames()
boolean	isConventionEnabled(java.lang.String shortName)
void	readSettings(Element node) Read in settings from XML config.
protected void	registerConvention(NamingConvention<T> convention)
protected void	registerConventionsListener(ExtensionPointName<NamingConvention<T>> epName)
void	setEnabled(boolean value, java.lang.String conventionShortName)
protected void	unregisterConvention(NamingConvention<T> extension)
void	writeSettings(Element node) Store current settings in XML config.

Methods inherited from class com.intellij.codeInspection.LocalInspectionTool

buildVisitor, 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, getGroupDisplayName, getGroupKey, getGroupPath, getMainToolId, getSerializationFilter, getShortName, getShortName, getStaticDescription, getSuppressors, initialize, isEnabledByDefault, isInitialized, isSuppressedFor, loadDescription, showDefaultConfigurationOptions

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNamingConventionInspection

protected AbstractNamingConventionInspection(java.lang.Iterable<NamingConvention<T>> extensions,
                                             java.lang.String defaultConventionShortName)

Method Detail

registerConvention

protected void registerConvention(NamingConvention<T> convention)

unregisterConvention

protected void unregisterConvention(NamingConvention<T> extension)

registerConventionsListener

protected void registerConventionsListener(ExtensionPointName<NamingConvention<T>> epName)

createRenameFix

protected abstract LocalQuickFix createRenameFix()

getNamingConventionBean

public NamingConventionBean getNamingConventionBean(java.lang.String shortName)

getOldToolNames

public java.util.Set<java.lang.String> getOldToolNames()

createErrorMessage

protected java.lang.String createErrorMessage(java.lang.String name,
                                              java.lang.String shortName)

readSettings

public void readSettings(Element node)

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.

writeSettings

public void writeSettings(Element node)

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.

isConventionEnabled

public boolean isConventionEnabled(java.lang.String shortName)

checkName

protected void checkName(T member,
                         java.lang.String name,
                         ProblemsHolder holder)

checkName

protected void checkName(T member,
                         java.util.function.Consumer<? super java.lang.String> errorRegister)

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.

setEnabled

public void setEnabled(boolean value,
                       java.lang.String conventionShortName)