com.puppycrawl.tools.checkstyle.checks.naming

Class LocalFinalVariableNameCheck

public class LocalFinalVariableNameCheck extends AbstractNameCheck

Checks that local 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="LocalFinalVariableName"/>
 

An example of how to configure the check for names that are only upper case letters and digits is:

 <module name="LocalFinalVariableName">
    <property name="format" value="^[A-Z][A-Z0-9]*$"/>
 </module>
 

Version: 1.0

Author: Rick Giles

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

Constructor Detail

LocalFinalVariableNameCheck

public LocalFinalVariableNameCheck()
Creates a new LocalFinalVariableNameCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()
{@inheritDoc}

mustCheckName

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