Package com.intellij.codeInspection.naming

Class NamingConvention<T extends PsiNameIdentifierOwner>

java.lang.Object

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

Direct Known Subclasses:

AbstractClassNamingConvention, AbstractTestClassNamingConvention, AnnotationNamingConvention, ClassNamingConvention, ConstantNamingConvention, ConstantWithMutableFieldTypeNamingConvention, EnumeratedClassNamingConvention, EnumeratedConstantNamingConvention, InstanceMethodNamingConvention, InstanceVariableNamingConvention, InterfaceNamingConvention, JUnit3MethodNamingConvention, JUnit4MethodNamingConvention, NativeMethodNamingConvention, StaticMethodNamingConvention, StaticVariableNamingConvention, TestClassNamingConvention, TestSuiteNamingConvention, TypeParameterNamingConvention

public abstract class NamingConvention<T extends PsiNameIdentifierOwner>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NamingConvention()

Method Summary

Modifier and Type	Method and Description
abstract NamingConventionBean	createDefaultBean()
java.lang.String	createErrorMessage(java.lang.String name, NamingConventionBean bean)
abstract java.lang.String	getElementDescription()
abstract java.lang.String	getShortName()
abstract boolean	isApplicable(T member)
boolean	isEnabledByDefault()
boolean	isValid(T member, NamingConventionBean bean)

Methods inherited from class java.lang.Object

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

Constructor Detail

NamingConvention

public NamingConvention()

Method Detail

isApplicable

public abstract boolean isApplicable(T member)

Returns:

true if member can be processed by this convention. The first convention which returns true, wins.

getElementDescription

public abstract java.lang.String getElementDescription()

Returns:

Text presentation which will be shown in check box UI

getShortName

public abstract java.lang.String getShortName()

Returns:

unique short name; if tool was already present and merging of settings is required (AbstractNamingConventionMerger), short name should be equal to the old tool name

createDefaultBean

public abstract NamingConventionBean createDefaultBean()

Returns:

default settings for the convention

isEnabledByDefault

public boolean isEnabledByDefault()

Returns:

true, if newly created inspection should contain this convention on. false, if convention should be disabled for newly created inspection or if inspection is merged from inspections, disabled by default.

createErrorMessage

public java.lang.String createErrorMessage(java.lang.String name,
                                           NamingConventionBean bean)

isValid

public boolean isValid(T member,
                       NamingConventionBean bean)