com.puppycrawl.tools.checkstyle.checks.naming

Class StaticVariableNameCheck

Implemented Interfaces:
Configurable, Contextualizable

public class StaticVariableNameCheck
extends AbstractNameCheck

Checks that static, non-final variable names conform to a format specified by the format property. 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="StaticVariableName"/>
 

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="StaticVariableName">
    <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
 </module>
 
Version:
1.0
Author:
Rick Giles

Constructor Summary

StaticVariableNameCheck()
Creates a new StaticVariableNameCheck 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, setCompileFlags, 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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

StaticVariableNameCheck

public StaticVariableNameCheck()
Creates a new StaticVariableNameCheck instance.

Method Details

getDefaultTokens

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

mustCheckName

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