com.puppycrawl.tools.checkstyle.checks.naming

Class LocalVariableNameCheck

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 {@link java.util.regex.Pattern 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>
 

Version: 1.0

Author: Rick Giles

Constructor Summary
LocalVariableNameCheck()
Creates a new LocalVariableNameCheck instance.
Method Summary
int[]getDefaultTokens()
{@inheritDoc}
protected booleanmustCheckName(DetailAST aAST)
{@inheritDoc}

Constructor Detail

LocalVariableNameCheck

public LocalVariableNameCheck()
Creates a new LocalVariableNameCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

mustCheckName

protected final boolean mustCheckName(DetailAST aAST)
{@inheritDoc}