com.puppycrawl.tools.checkstyle.checks.naming

Class AbbreviationAsWordInNameCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.naming.AbbreviationAsWordInNameCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class AbbreviationAsWordInNameCheck
extends AbstractCheck

The Check validate abbreviations(consecutive capital letters) length in identifier name, it also allows to enforce camel case naming. Please read more at Google Style Guide to get to know how to avoid long abbreviations in names.

allowedAbbreviationLength specifies how many consecutive capital letters are allowed in the identifier. A value of 3 indicates that up to 4 consecutive capital letters are allowed, one after the other, before a violation is printed. The identifier 'MyTEST' would be allowed, but 'MyTESTS' would not be. A value of 0 indicates that only 1 consecutive capital letter is allowed. This is what should be used to enforce strict camel casing. The identifier 'MyTest' would be allowed, but 'MyTEst' would not be.

• Property allowedAbbreviationLength - Indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ... ). Default value is 3.
• Property allowedAbbreviations - Specify list of abbreviations that must be skipped for checking. Abbreviations should be separated by comma. Default value is {}.
• Property ignoreFinal - Allow to skip variables with final modifier. Default value is true.
• Property ignoreStatic - Allow to skip variables with static modifier. Default value is true.
• Property ignoreOverriddenMethods - Allow to ignore methods tagged with @Override annotation (that usually mean inherited name). Default value is true.
• Property tokens - tokens to check Default value is: CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF.

Default configuration

 <module name="AbbreviationAsWordInName"/>
 

To configure to check variables and classes identifiers, do not ignore variables with static modifier and allow no abbreviations (enforce camel case phrase) and allow no abbreviations to use (camel case phrase) and allow XML and URL abbreviations.

 <module name="AbbreviationAsWordInName">
   <property name="tokens" value="VARIABLE_DEF,CLASS_DEF"/>
   <property name="ignoreStatic" value="false"/>
   <property name="allowedAbbreviationLength" value="1"/>
   <property name="allowedAbbreviations" value="XML,URL"/>
 </module>
 

Since:

5.8

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_KEY Warning message key.

Constructor Summary

Constructors

Constructor and Description
AbbreviationAsWordInNameCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
int[]	getRequiredTokens() The tokens that this check must be registered for.
void	setAllowedAbbreviationLength(int allowedAbbreviationLength) Setter to indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ...
void	setAllowedAbbreviations(java.lang.String... allowedAbbreviations) Setter to specify list of abbreviations that must be skipped for checking.
void	setIgnoreFinal(boolean ignoreFinal) Setter to allow to skip variables with final modifier.
void	setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) Setter to allow to ignore methods tagged with @Override annotation (that usually mean inherited name).
void	setIgnoreStatic(boolean ignoreStatic) Setter to allow to skip variables with static modifier.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Detail

MSG_KEY

public static final java.lang.String MSG_KEY

Warning message key.

See Also:

Constant Field Values

Constructor Detail

AbbreviationAsWordInNameCheck

public AbbreviationAsWordInNameCheck()

Method Detail

setIgnoreFinal

public void setIgnoreFinal(boolean ignoreFinal)

Setter to allow to skip variables with final modifier.

Parameters:

ignoreFinal - Defines if ignore variables with 'final' modifier or not.

setIgnoreStatic

public void setIgnoreStatic(boolean ignoreStatic)

Setter to allow to skip variables with static modifier.

Parameters:

ignoreStatic - Defines if ignore variables with 'static' modifier or not.

setIgnoreOverriddenMethods

public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods)

Setter to allow to ignore methods tagged with @Override annotation (that usually mean inherited name).

Parameters:

ignoreOverriddenMethods - Defines if ignore methods with "@Override" annotation or not.

setAllowedAbbreviationLength

public void setAllowedAbbreviationLength(int allowedAbbreviationLength)

Setter to indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ... ).

Parameters:

allowedAbbreviationLength - amount of allowed capital letters in abbreviation.

setAllowedAbbreviations

public void setAllowedAbbreviations(java.lang.String... allowedAbbreviations)

Setter to specify list of abbreviations that must be skipped for checking. Abbreviations should be separated by comma.

Parameters:

allowedAbbreviations - an string of abbreviations that must be skipped from checking, each abbreviation separated by comma.

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: AbstractCheck

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class AbstractCheck

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: AbstractCheck

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Specified by:

getAcceptableTokens in class AbstractCheck

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Specified by:

getRequiredTokens in class AbstractCheck

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process