public class ConstantNameCheck extends AbstractAccessControlNameCheck
Checks that constant names conform to a format specified by the format property. A constant is a static and final field or an interface/annotation field, except serialVersionUID and serialPersistentFields . The format is a regular expression and defaults to ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$.
An example of how to configure the check is:
<module name="ConstantName"/>
An example of how to configure the check for names that are only upper case letters and digits is:
<module name="ConstantName">
<property name="format" value="^[A-Z][A-Z0-9]*$"/>
</module>
MSG_INVALID_PATTERN| Constructor and Description |
|---|
ConstantNameCheck()
Creates a new
ConstantNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
protected boolean |
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against
the format regexp.
|
getApplyToPackage, getApplyToPrivate, getApplyToProtected, getApplyToPublic, setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopevisitTokengetFormat, getRegexp, setCompileFlags, setFormatbeginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic ConstantNameCheck()
ConstantNameCheck instance.public int[] getDefaultTokens()
CheckgetDefaultTokens in class CheckTokenTypesprotected final boolean mustCheckName(DetailAST ast)
AbstractNameCheckmustCheckName in class AbstractAccessControlNameCheckast - the AST to check.Copyright © 2001–2015. All rights reserved.