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>
Constructor and Description |
---|
LocalVariableNameCheck()
Creates a new
LocalVariableNameCheck 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.
|
visitToken
getFormat, getRegexp, setCompileFlags, setFormat
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public LocalVariableNameCheck()
LocalVariableNameCheck
instance.public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
protected final boolean mustCheckName(DetailAST aAST)
AbstractNameCheck
mustCheckName
in class AbstractNameCheck
aAST
- the AST to check.Copyright © 2001-2013. All Rights Reserved.