com.puppycrawl.tools.checkstyle.checks.naming
Class ConstantNameCheck

java.lang.Object
  com.puppycrawl.tools.checkstyle.api.AutomaticBean
      com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
          com.puppycrawl.tools.checkstyle.api.Check
              com.puppycrawl.tools.checkstyle.checks.AbstractFormatCheck
                  com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
                      com.puppycrawl.tools.checkstyle.checks.naming.ConstantNameCheck

All 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 field, except serialVersionUID. 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() Returns the default token a check is interested in.
protected boolean	mustCheckName(DetailAST aAST) Decides whether the name of an AST should be checked against the format regexp.

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

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, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getMessageBundle, getSeverity, getSeverityLevel, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConstantNameCheck

public ConstantNameCheck()

Creates a new ConstantNameCheck instance.

Method Detail

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.

Specified by:

getDefaultTokens in class Check

Returns:

the default tokens

See Also:

Check

mustCheckName

protected final boolean mustCheckName(DetailAST aAST)

Description copied from class: AbstractNameCheck

Decides whether the name of an AST should be checked against the format regexp.

Overrides:

mustCheckName in class AbstractNameCheck

Parameters:

aAST - the AST to check.

Returns:

true if the IDENT subnode of aAST should be checked against the format regexp.

See Also:

AbstractNameCheck