Package com.puppycrawl.tools.checkstyle.checks.naming

Class LocalVariableNameCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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 specified pattern. A catch parameter is considered to be a local variable.

This check does not support pattern variables. Instead, use PatternVariableName.

• Property allowOneCharVarInForLoop - Allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp. Type is boolean. Default value is false.
• Property format - Sets the pattern to match valid identifiers. Type is java.util.regex.Pattern. Default value is "^([a-z][a-zA-Z0-9]*|_)$".

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• name.invalidPattern

Since:

3.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	allowOneCharVarInForLoop	Allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

MSG_INVALID_PATTERN

Constructor Summary

Constructors

Constructor	Description
LocalVariableNameCheck()	Creates a new LocalVariableNameCheck instance.

Method Summary

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 final boolean	mustCheckName(DetailAST ast)	Decides whether the name of an AST should be checked against the format regexp.
final void	setAllowOneCharVarInForLoop(boolean allow)	Setter to allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

setFormat, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

allowOneCharVarInForLoop

private boolean allowOneCharVarInForLoop

Allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.

Constructor Details

LocalVariableNameCheck

public LocalVariableNameCheck()

Creates a new LocalVariableNameCheck instance.

Method Details

setAllowOneCharVarInForLoop

public final void setAllowOneCharVarInForLoop(boolean allow)

Setter to allow one character variable name in initialization expressions in FOR loop if one char variable name is prohibited by format regexp.

Parameters:

allow - Flag for allowing or not one character name in FOR loop.

Since:

5.8

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 class AbstractCheck

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 class AbstractCheck

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 class AbstractCheck

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 class AbstractNameCheck

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.