Class AbbreviationAsWordInNameCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Validates 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.
ignoreFinal
, ignoreStatic
, and ignoreStaticFinal
control whether variables with the respective modifiers are to be ignored.
Note that a variable that is both static and final will always be considered under
ignoreStaticFinal
only, regardless of the values of ignoreFinal
and ignoreStatic
. So for example if ignoreStatic
is true but
ignoreStaticFinal
is false, then static final variables will not be ignored.
-
Property
allowedAbbreviationLength
- Indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ... ). Type isint
. Default value is3
. -
Property
allowedAbbreviations
- Specify list of abbreviations that must be skipped for checking. Abbreviations should be separated by comma. Type isjava.lang.String[]
. Default value is""
. -
Property
ignoreFinal
- Allow to skip variables withfinal
modifier. Type isboolean
. Default value istrue
. -
Property
ignoreStatic
- Allow to skip variables withstatic
modifier. Type isboolean
. Default value istrue
. -
Property
ignoreStaticFinal
- Allow to skip variables with bothstatic
andfinal
modifiers. Type isboolean
. Default value istrue
. -
Property
ignoreOverriddenMethods
- Allow to ignore methods tagged with@Override
annotation (that usually mean inherited name). Type isboolean
. Default value istrue
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, ANNOTATION_FIELD_DEF, PARAMETER_DEF, VARIABLE_DEF, METHOD_DEF, PATTERN_VARIABLE_DEF, RECORD_DEF, RECORD_COMPONENT_DEF.
To configure the check:
<module name="AbbreviationAsWordInName"/>
Example:
public class MyClass extends SuperClass { // OK, camel case int CURRENT_COUNTER; // violation, at most 4 consecutive capital letters allowed static int GLOBAL_COUNTER; // OK, static is ignored final Set<String> stringsFOUND = new HashSet<>(); // OK, final is ignored @Override void printCOUNTER() { // OK, overridden method is ignored System.out.println(CURRENT_COUNTER); // OK, only definitions are checked } void incrementCOUNTER() { // violation, at most 4 consecutive capital letters allowed CURRENT_COUNTER++; // OK, only definitions are checked } static void incrementGLOBAL() { // violation, static method is not ignored GLOBAL_COUNTER++; // OK, only definitions are checked } }
To configure to include static variables and methods tagged with
@Override
annotation.
Configuration:
<module name="AbbreviationAsWordInName"> <property name="ignoreStatic" value="false"/> <property name="ignoreOverriddenMethods" value="false"/> </module>
Example:
public class MyClass extends SuperClass { // OK, camel case int CURRENT_COUNTER; // violation, at most 4 consecutive capital letters allowed static int GLOBAL_COUNTER; // violation, static is not ignored final Set<String> stringsFOUND = new HashSet<>(); // OK, final is ignored @Override void printCOUNTER() { // violation, overridden method is not ignored System.out.println(CURRENT_COUNTER); // OK, only definitions are checked } void incrementCOUNTER() { // violation, at most 4 consecutive capital letters allowed CURRENT_COUNTER++; // OK, only definitions are checked } static void incrementGLOBAL() { // violation, at most 4 consecutive capital letters allowed GLOBAL_COUNTER++; // OK, only definitions are checked } }
To configure to check all variables and identifiers (including ones with the static modifier) and enforce no abbreviations (essentially camel case) except for words like 'XML' and 'URL'.
Configuration:
<module name="AbbreviationAsWordInName"> <property name="tokens" value="VARIABLE_DEF,CLASS_DEF"/> <property name="ignoreStatic" value="false"/> <property name="allowedAbbreviationLength" value="0"/> <property name="allowedAbbreviations" value="XML,URL"/> </module>
Example:
public class MyClass { // OK int firstNum; // OK int secondNUM; // violation, it allowed only 1 consecutive capital letter static int thirdNum; // OK, the static modifier would be checked static int fourthNUm; // violation, the static modifier would be checked, // and only 1 consecutive capital letter is allowed String firstXML; // OK, XML abbreviation is allowed String firstURL; // OK, URL abbreviation is allowed final int TOTAL = 5; // OK, final is ignored static final int LIMIT = 10; // OK, static final is ignored }
To configure to check variables, excluding fields with the static modifier, and allow abbreviations up to 2 consecutive capital letters ignoring the longer word 'CSV'.
Configuration:
<module name="AbbreviationAsWordInName"> <property name="tokens" value="VARIABLE_DEF"/> <property name="ignoreStatic" value="true"/> <property name="allowedAbbreviationLength" value="1"/> <property name="allowedAbbreviations" value="CSV"/> </module>
Example:
public class MyClass { // OK, ignore checking the class name int firstNum; // OK, abbreviation "N" is of allowed length 1 int secondNUm; // OK int secondMYNum; // violation, found "MYN" but only // 2 consecutive capital letters are allowed int thirdNUM; // violation, found "NUM" but it is allowed // only 2 consecutive capital letters static int fourthNUM; // OK, variables with static modifier // would be ignored String firstCSV; // OK, CSV abbreviation is allowed String firstXML; // violation, XML abbreviation is not allowed final int TOTAL = 5; // OK, final is ignored static final int LIMIT = 10; // OK, static final is ignored }
To configure to check variables, enforcing no abbreviations except for variables that are both static and final.
Configuration:
<module name="AbbreviationAsWordInName"> <property name="tokens" value="VARIABLE_DEF"/> <property name="ignoreFinal" value="false"/> <property name="ignoreStatic" value="false"/> <property name="ignoreStaticFinal" value="true"/> <property name="allowedAbbreviationLength" value="0"/> </module>
Example:
public class MyClass { public int counterXYZ = 1; // violation public final int customerID = 2; // violation public static int nextID = 3; // violation public static final int MAX_ALLOWED = 4; // OK, ignored }
To configure to check variables, enforcing no abbreviations and ignoring static (but non-final) variables only.
Configuration:
<module name="AbbreviationAsWordInName"> <property name="tokens" value="VARIABLE_DEF"/> <property name="ignoreFinal" value="false"/> <property name="ignoreStatic" value="true"/> <property name="ignoreStaticFinal" value="false"/> <property name="allowedAbbreviationLength" value="0"/> </module>
Example:
public class MyClass { public int counterXYZ = 1; // violation public final int customerID = 2; // violation public static int nextID = 3; // OK, ignored public static final int MAX_ALLOWED = 4; // violation }
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
abbreviation.as.word
- Since:
- 5.8
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate int
Indicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ...Specify list of abbreviations that must be skipped for checking.private static final int
The default value of "allowedAbbreviationLength" option.private boolean
Allow to skip variables withfinal
modifier.private boolean
Allow to ignore methods tagged with@Override
annotation (that usually mean inherited name).private boolean
Allow to skip variables withstatic
modifier.private boolean
Allow to skip variables with bothstatic
andfinal
modifiers.static final String
Warning message key. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate static String
getAbbreviation
(String str, int beginIndex, int endIndex) Gets the abbreviation, wherebeginIndex
andendIndex
are inclusive indexes of a sequence of consecutive upper-case characters.private String
getAbbreviationIfIllegal
(String str, int beginIndex, int endIndex) Get Abbreviation if it is illegal, wherebeginIndex
andendIndex
are inclusive indexes of a sequence of consecutive upper-case characters.int[]
The configurable token set.getChildren
(DetailAST node) Gets all the children which are one level below on the current DetailAST parent node.int[]
Returns the default token a check is interested in.private String
Gets the disallowed abbreviation contained in given String.int[]
The tokens that this check must be registered for.private boolean
hasIgnoredModifiers
(DetailAST modifiers) Checks if a variable is to be ignored based on its modifiers.private static boolean
hasOverrideAnnotation
(DetailAST methodModifiersAST) Checks that the method has "@Override" annotation.private boolean
Checks if it is an ignore situation.private static boolean
isInterfaceDeclaration
(DetailAST variableDefAst) Check that variable definition in interface or @interface definition.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
(String... allowedAbbreviations) Setter to specify list of abbreviations that must be skipped for checking.void
setIgnoreFinal
(boolean ignoreFinal) Setter to allow to skip variables withfinal
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 withstatic
modifier.void
setIgnoreStaticFinal
(boolean ignoreStaticFinal) Setter to allow to skip variables with bothstatic
andfinal
modifiers.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, 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
-
Field Details
-
MSG_KEY
Warning message key.- See Also:
-
DEFAULT_ALLOWED_ABBREVIATIONS_LENGTH
private static final int DEFAULT_ALLOWED_ABBREVIATIONS_LENGTHThe default value of "allowedAbbreviationLength" option.- See Also:
-
allowedAbbreviationLength
private int allowedAbbreviationLengthIndicate the number of consecutive capital letters allowed in targeted identifiers (abbreviations in the classes, interfaces, variables and methods names, ... ). -
allowedAbbreviations
Specify list of abbreviations that must be skipped for checking. Abbreviations should be separated by comma. -
ignoreFinal
private boolean ignoreFinalAllow to skip variables withfinal
modifier. -
ignoreStatic
private boolean ignoreStaticAllow to skip variables withstatic
modifier. -
ignoreStaticFinal
private boolean ignoreStaticFinalAllow to skip variables with bothstatic
andfinal
modifiers. -
ignoreOverriddenMethods
private boolean ignoreOverriddenMethodsAllow to ignore methods tagged with@Override
annotation (that usually mean inherited name).
-
-
Constructor Details
-
AbbreviationAsWordInNameCheck
public AbbreviationAsWordInNameCheck()
-
-
Method Details
-
setIgnoreFinal
public void setIgnoreFinal(boolean ignoreFinal) Setter to allow to skip variables withfinal
modifier.- Parameters:
ignoreFinal
- Defines if ignore variables with 'final' modifier or not.
-
setIgnoreStatic
public void setIgnoreStatic(boolean ignoreStatic) Setter to allow to skip variables withstatic
modifier.- Parameters:
ignoreStatic
- Defines if ignore variables with 'static' modifier or not.
-
setIgnoreStaticFinal
public void setIgnoreStaticFinal(boolean ignoreStaticFinal) Setter to allow to skip variables with bothstatic
andfinal
modifiers.- Parameters:
ignoreStaticFinal
- Defines if ignore variables with both 'static' and 'final' modifiers 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
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 classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
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 classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
isIgnoreSituation
Checks if it is an ignore situation.- Parameters:
ast
- input DetailAST node.- Returns:
- true if it is an ignore situation found for given input DetailAST node.
-
hasIgnoredModifiers
Checks if a variable is to be ignored based on its modifiers.- Parameters:
modifiers
- modifiers of the variable to be checked- Returns:
- true if there is a modifier to be ignored
-
isInterfaceDeclaration
Check that variable definition in interface or @interface definition.- Parameters:
variableDefAst
- variable definition.- Returns:
- true if variable definition(variableDefAst) is in interface or @interface definition.
-
hasOverrideAnnotation
Checks that the method has "@Override" annotation.- Parameters:
methodModifiersAST
- A DetailAST nod is related to the given method modifiers (MODIFIERS type).- Returns:
- true if method has "@Override" annotation.
-
getDisallowedAbbreviation
Gets the disallowed abbreviation contained in given String.- Parameters:
str
- the given String.- Returns:
- the disallowed abbreviation contained in given String as a separate String.
-
getAbbreviationIfIllegal
Get Abbreviation if it is illegal, wherebeginIndex
andendIndex
are inclusive indexes of a sequence of consecutive upper-case characters.- Parameters:
str
- namebeginIndex
- begin indexendIndex
- end index- Returns:
- the abbreviation if it is bigger than required and not in the
ignore list, otherwise
null
-
getAbbreviation
Gets the abbreviation, wherebeginIndex
andendIndex
are inclusive indexes of a sequence of consecutive upper-case characters.The character at
endIndex
is only included in the abbreviation if it is the last character in the string; otherwise it is usually the first capital in the next word.For example,
getAbbreviation("getXMLParser", 3, 6)
returns "XML" (not "XMLP"), and so doesgetAbbreviation("parseXML", 5, 7)
.- Parameters:
str
- namebeginIndex
- begin indexendIndex
- end index- Returns:
- the specified abbreviation
-
getChildren
Gets all the children which are one level below on the current DetailAST parent node.- Parameters:
node
- Current parent node.- Returns:
- The list of children one level below on the current parent node.
-