Package 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.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.naming.AbstractNameCheck
com.puppycrawl.tools.checkstyle.checks.naming.ClassTypeParameterNameCheck
All Implemented Interfaces:
Configurable, Contextualizable
public class ClassTypeParameterNameCheck extends AbstractNameCheck

Checks that class type parameter names conform to a specified pattern.

  • Property 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
Since:
5.0

  • Constructor Details

    • ClassTypeParameterNameCheck

      public ClassTypeParameterNameCheck()
      Creates a new ClassTypeParameterNameCheck instance.

  • Method Details

    • getDefaultTokens

      public int[] getDefaultTokens()
      Description copied from class: AbstractCheck
      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 AbstractCheck
      Returns:
      the default tokens
      See Also:

    • getAcceptableTokens

      public final int[] getAcceptableTokens()
      Description copied from class: AbstractCheck
      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.
      Specified by:
      getAcceptableTokens in class AbstractCheck
      Returns:
      the token set this check is designed for.
      See Also:

    • getRequiredTokens

      public int[] getRequiredTokens()
      Description copied from class: AbstractCheck
      The tokens that this check must be registered for.
      Specified by:
      getRequiredTokens in class AbstractCheck
      Returns:
      the token set this must be registered for.
      See Also:

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