com.puppycrawl.tools.checkstyle.checks.naming

Class ConstantNameCheck

Implemented Interfaces:
Configurable, Contextualizable

public class ConstantNameCheck
extends AbstractNameCheck

Checks that constant names conform to a format specified by the format property. A constant is a static and final field or an interface/annotation field, except serialVersionUID and serialPersistentFields . The format is a regular expression and defaults to ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$.

An example of how to configure the check is:

 <module name="ConstantName"/>
 

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

 <module name="ConstantName">
    <property name="format" value="^[A-Z][A-Z0-9]*$"/>
 </module>
 
Version:
1.0
Author:
Rick Giles

Constructor Summary

ConstantNameCheck()
Creates a new ConstantNameCheck 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

ConstantNameCheck

public ConstantNameCheck()
Creates a new ConstantNameCheck instance.

Method Details

getDefaultTokens

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

mustCheckName

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