com.puppycrawl.tools.checkstyle.checks.naming

Class AbstractTypeParameterNameCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

Direct Known Subclasses:

ClassTypeParameterNameCheck, InterfaceTypeParameterNameCheck, MethodTypeParameterNameCheck

public abstract class AbstractTypeParameterNameCheck
extends AbstractNameCheck

Abstract class for checking if a class/method type parameter's name conforms to a format specified by the format property.

This class extends AbstractNameCheck

Author:

Travis Schneeberger

Field Summary

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

MSG_INVALID_PATTERN

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
protected abstract int	getLocation() This method must be overridden to specify the location of the type parameter to check.
protected boolean	mustCheckName(DetailAST ast) 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, setCompileFlags, setFormat

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

beginTree, destroy, finishTree, getClassLoader, 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

Constructor Detail

AbstractTypeParameterNameCheck

protected AbstractTypeParameterNameCheck(String format)

Creates a new AbstractTypeParameterNameCheck instance.

Parameters:

format - format to check with

Method Detail

getDefaultTokens

public final 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:

TokenTypes

getAcceptableTokens

public final int[] getAcceptableTokens()

Description copied from class: Check

The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

mustCheckName

protected final boolean mustCheckName(DetailAST ast)

Description copied from class: AbstractNameCheck

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

Specified by:

mustCheckName in class AbstractNameCheck

Parameters:

ast - the AST to check.

Returns:

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

getLocation

protected abstract int getLocation()

This method must be overridden to specify the location of the type parameter to check.

Returns:

TokenTypes.CLASS_DEF or TokenTypes.METHOD_DEF