Class AbstractNameCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

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, CatchParameterNameCheck, ClassTypeParameterNameCheck, IllegalIdentifierNameCheck, InterfaceTypeParameterNameCheck, LambdaParameterNameCheck, LocalFinalVariableNameCheck, LocalVariableNameCheck, MethodTypeParameterNameCheck, ParameterNameCheck, PatternVariableNameCheck, RecordComponentNameCheck, RecordTypeParameterNameCheck

public abstract class AbstractNameCheck
extends AbstractCheck

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

Nested Class Summary

Nested classes/interfaces inherited from class AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private Pattern	format	The regexp to match against.
static final String	MSG_INVALID_PATTERN	Message key for invalid pattern violation.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected abstract boolean	mustCheckName(DetailAST ast)	Decides whether the name of an AST should be checked against the format regexp.
final void	setFormat(Pattern pattern)	Sets the pattern to match valid identifiers.
void	visitToken(DetailAST ast)	Called to process a token.

Methods inherited from class AbstractCheck

beginTree, clearViolations, destroy, finishTree, getAcceptableTokens, getDefaultTokens, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getRequiredTokens, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class AbstractViolationReporter

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

Methods inherited from class AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class Object

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

Field Details

MSG_INVALID_PATTERN

public static final String MSG_INVALID_PATTERN

Message key for invalid pattern violation.

See Also:

• Constant Field Values

format

private Pattern format

The regexp to match against.

Constructor Details

AbstractNameCheck

protected AbstractNameCheck(String format)

Creates a new AbstractNameCheck instance.

Parameters:

format - format to check with

Method Details

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)

Sets the pattern to match valid identifiers.

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