Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks.naming

Class LocalVariableNameCheck

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>

Version:
1.0

Author:
Rick Giles

Constructor Summary

LocalVariableNameCheck()
Creates a new LocalVariableNameCheck instance.

Method Summary

int[]
getDefaultTokens()
protected boolean
mustCheckName(DetailAST aAST)

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

mustCheckName, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck

getFormat, getRegexp, setFormat

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

LocalVariableNameCheck

public LocalVariableNameCheck()
Creates a new LocalVariableNameCheck instance.

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

See Also:
Check

mustCheckName

protected final boolean mustCheckName(DetailAST aAST)
Overrides:
mustCheckName in interface AbstractNameCheck

See Also:
AbstractNameCheck

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page