public class StaticVariableNameCheck extends AbstractAccessControlNameCheck
Checks that static, non-final variable names conform to a format specified
by the format property.
format - Specifies valid identifiers. Default value is
"^[a-z][a-zA-Z0-9]*$".
applyToPublic - Controls whether to apply the check to public member.
Default value is true.
applyToProtected - Controls whether to apply the check to protected member.
Default value is true.
applyToPackage - Controls whether to apply the check to package-private member.
Default value is true.
applyToPrivate - Controls whether to apply the check to private member.
Default value is true.
An example of how to configure the check is:
<module name="StaticVariableName"/>
An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores is:
<module name="StaticVariableName"> <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/> </module>
AutomaticBean.OutputStreamOptionsMSG_INVALID_PATTERN| Constructor and Description |
|---|
StaticVariableNameCheck()
Creates a new
StaticVariableNameCheck instance. |
| 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.
|
protected boolean |
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against
the format regexp.
|
setApplyToPackage, setApplyToPrivate, setApplyToProtected, setApplyToPublic, shouldCheckInScopesetFormat, visitTokenbeginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic StaticVariableNameCheck()
StaticVariableNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypesprotected final boolean mustCheckName(DetailAST ast)
AbstractNameCheckmustCheckName in class AbstractAccessControlNameCheckast - the AST to check.Copyright © 2001-2019. All Rights Reserved.