public class LocalFinalVariableNameCheck extends AbstractNameCheck
Checks that local final variable names conform to a format specified
by the format property. A catch parameter is considered to be
a local variable.The format is a
regular expression and defaults to
^[a-z][a-zA-Z0-9]*$.
An example of how to configure the check is:
<module name="LocalFinalVariableName"/>
An example of how to configure the check for names that are only upper case letters and digits is:
<module name="LocalFinalVariableName">
<property name="format" value="^[A-Z][A-Z0-9]*$"/>
</module>
| Constructor and Description |
|---|
LocalFinalVariableNameCheck()
Creates a new
LocalFinalVariableNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
protected boolean |
mustCheckName(DetailAST aAST)
Decides whether the name of an AST should be checked against
the format regexp.
|
visitTokengetFormat, getRegexp, setCompileFlags, setFormatbeginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic LocalFinalVariableNameCheck()
LocalFinalVariableNameCheck instance.public int[] getDefaultTokens()
CheckgetDefaultTokens in class CheckTokenTypesprotected final boolean mustCheckName(DetailAST aAST)
AbstractNameCheckmustCheckName in class AbstractNameCheckaAST - the AST to check.Copyright © 2001-2017. All Rights Reserved.