Class LocalVariableNameCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
-
- com.puppycrawl.tools.checkstyle.checks.naming.LocalVariableNameCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
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>
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowOneCharVarInForLoop
Allow one character name for initialization expression in FOR loop.private static java.util.regex.Pattern
SINGLE_CHAR
Regexp for one-char loop variables.-
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
MSG_INVALID_PATTERN
-
-
Constructor Summary
Constructors Constructor Description LocalVariableNameCheck()
Creates a newLocalVariableNameCheck
instance.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method 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.private static boolean
isForLoopVariable(DetailAST variableDef)
Checks if a variable is the loop's one.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.-
Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
setFormat, visitToken
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Method Detail
-
setAllowOneCharVarInForLoop
public final void setAllowOneCharVarInForLoop(boolean allow)
Sets whether to allow one character name in FOR loop or not.- Parameters:
allow
- Flag for allowing or not one character name in FOR loop.
-
getDefaultTokens
public int[] getDefaultTokens()
Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
TokenTypes
-
getAcceptableTokens
public int[] getAcceptableTokens()
Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
TokenTypes
-
getRequiredTokens
public int[] getRequiredTokens()
Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
mustCheckName
protected final boolean mustCheckName(DetailAST ast)
Description copied from class:AbstractNameCheck
Decides whether the name of an AST should be checked against the format regexp.- Specified by:
mustCheckName
in classAbstractNameCheck
- Parameters:
ast
- the AST to check.- Returns:
- true if the IDENT subnode of ast should be checked against the format regexp.
-
isForLoopVariable
private static boolean isForLoopVariable(DetailAST variableDef)
Checks if a variable is the loop's one.- Parameters:
variableDef
- variable definition.- Returns:
- true if a variable is the loop's one.
-
-