com.puppycrawl.tools.checkstyle.checks.naming

Class ClassTypeParameterNameCheck

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

com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class ClassTypeParameterNameCheck
extends AbstractTypeParameterNameCheck

Checks that class type parameter names conform to a format specified by the format property. The format is a regular expression and defaults to ^[A-Z]$.

An example of how to configure the check is:

 <module name="ClassTypeParameterName"/>
 

An example of how to configure the check for names that are only a single letter is

 <module name="ClassTypeParameterName">
    <property name="format" value="^[a-zA-Z]$"/>
 </module>
 

Author:

Travis Schneeberger

Field Summary

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

MSG_INVALID_PATTERN

Constructor Summary

Constructors

Constructor and Description
ClassTypeParameterNameCheck() Creates a new ClassTypeParameterNameCheck instance.

Method Summary

Modifier and Type	Method and Description
protected int	getLocation() This method must be overridden to specify the location of the type parameter to check.
int[]	getRequiredTokens() The tokens that this check must be registered for.

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

getAcceptableTokens, getDefaultTokens, mustCheckName

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

ClassTypeParameterNameCheck

public ClassTypeParameterNameCheck()

Creates a new ClassTypeParameterNameCheck instance.

Method Detail

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

getLocation

protected final int getLocation()

Description copied from class: AbstractTypeParameterNameCheck

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

Specified by:

getLocation in class AbstractTypeParameterNameCheck

Returns:

TokenTypes.CLASS_DEF or TokenTypes.METHOD_DEF