public class LocalVariableNameCheck extends AbstractNameCheck
Checks that local, non-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="LocalVariableName"/>
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="LocalVariableName">
<property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
</module>
An example of one character variable name in initialization expression(like "i") in FOR loop:
for(int i = 1; i < 10; i++) {}
An example of how to configure the check to allow one char variable name in initialization expressions in FOR loop:
<module name="LocalVariableName">
<property name="allowOneCharVarInForLoop" value="true"/>
</module>
AutomaticBean.OutputStreamOptionsMSG_INVALID_PATTERN| Constructor and Description |
|---|
LocalVariableNameCheck()
Creates a new
LocalVariableNameCheck 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.
|
void |
setAllowOneCharVarInForLoop(boolean allow)
Sets whether to allow one character name in FOR loop or not.
|
setFormat, visitTokenbeginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic LocalVariableNameCheck()
LocalVariableNameCheck instance.public final void setAllowOneCharVarInForLoop(boolean allow)
allow - Flag for allowing or not one character name in FOR loop.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 AbstractNameCheckast - the AST to check.Copyright © 2001-2017. All Rights Reserved.