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.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

AbstractAccessControlNameCheck, AbstractTypeParameterNameCheck, CatchParameterNameCheck, ClassTypeParameterNameCheck, InterfaceTypeParameterNameCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MethodTypeParameterNameCheck, ParameterNameCheck

public abstract class AbstractNameCheck
extends AbstractCheck

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

Author:

Rick Giles

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	mustCheckName(DetailAST ast) Decides whether the name of an AST should be checked against the format regexp.
void	setFormat(Pattern pattern) Set the format for the specified regular expression.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, clearMessages, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLine, getLines, getMessages, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens

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

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

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

configure, contextualize, 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

protected AbstractNameCheck(String format)

Creates a new AbstractNameCheck instance.

Parameters:

format - format to check with

Method Detail

mustCheckName

protected abstract 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.

setFormat

public final void setFormat(Pattern pattern)

Set the format for the specified regular expression.

Parameters:

pattern - the new pattern

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractCheck

Parameters:

ast - the token to process