public class ClassTypeParameterNameCheck extends AbstractNameCheck
Checks that class type parameter names conform to a specified pattern.
format - Specifies valid identifiers.
Type is java.util.regex.Pattern.
Default value is "^[A-Z]$".
To configure the check:
<module name="ClassTypeParameterName"/>
Example:
class MyClass1<T> {} // OK
class MyClass2<t> {} // violation
class MyClass3<abc> {} // violation
class MyClass4<LISTENER> {} // violation
class MyClass5<RequestT> {} // violation
To configure the check for names that are uppercase word:
<module name="ClassTypeParameterName">
<property name="format" value="^[A-Z]{2,}$"/>
</module>
Example:
class MyClass1<T> {} // violation
class MyClass2<t> {} // violation
class MyClass3<abc> {} // violation
class MyClass4<LISTENER> {} // OK
class MyClass5<RequestT> {} // violation
To configure the check for names that are camel case word with T as suffix ( Google Style):
<module name="ClassTypeParameterName"> <property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*[T]$)"/> </module>
Example:
class MyClass1<T> {} // violation
class MyClass2<t> {} // violation
class MyClass3<abc> {} // violation
class MyClass4<LISTENER> {} // violation
class MyClass5<RequestT> {} // OK
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
name.invalidPattern
AutomaticBean.OutputStreamOptionsMSG_INVALID_PATTERN| Constructor and Description |
|---|
ClassTypeParameterNameCheck()
Creates a new
ClassTypeParameterNameCheck instance. |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
protected boolean |
mustCheckName(DetailAST ast)
Decides whether the name of an AST should be checked against
the format regexp.
|
setFormat, visitTokenbeginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic ClassTypeParameterNameCheck()
ClassTypeParameterNameCheck instance.public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic final int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypesprotected final boolean mustCheckName(DetailAST ast)
AbstractNameCheckmustCheckName in class AbstractNameCheckast - the AST to check.Copyright © 2001-2022. All Rights Reserved.