com.puppycrawl.tools.checkstyle.checks.naming

Class AbstractNameCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AbstractAccessControlNameCheck, AbstractTypeParameterNameCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, ParameterNameCheck

public abstract class AbstractNameCheck
extends AbstractFormatCheck

Abstract class for checking that names conform to a specified format.

Version:

1.0

Author:

Rick Giles

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_INVALID_PATTERN Message key for invalid pattern error.

Constructor Summary

Constructors

Constructor and Description
AbstractNameCheck(String format) Creates a new AbstractNameCheck instance.

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	mustCheckName(DetailAST ast) Decides whether the name of an AST should be checked against the format regexp.
void	visitToken(DetailAST ast) Called to process a token.

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

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, 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

Field Detail

MSG_INVALID_PATTERN

public static final String MSG_INVALID_PATTERN

Message key for invalid pattern error.

See Also:

Constant Field Values

Constructor Detail

AbstractNameCheck

public AbstractNameCheck(String format)

Creates a new AbstractNameCheck instance.

Parameters:

format - format to check with

Method Detail

mustCheckName

protected boolean mustCheckName(DetailAST ast)

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

Parameters:

ast - the AST to check.

Returns:

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process