Package com.puppycrawl.tools.checkstyle.checks.naming

Class MethodTypeParameterNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class MethodTypeParameterNameCheck
extends AbstractNameCheck

    Checks that method 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="MethodTypeParameterName"/>

    Code Example:

     class MyClass {
   public <T> void method1() {} // OK
   public <a> void method2() {} // violation,  name 'a' must match pattern '^[A-Z]$'
   public <K, V> void method3() {} // OK
   public <k, V> void method4() {} // violation, name 'k' must match pattern '^[A-Z]$'
 }

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

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

    Code Example:

     class MyClass {
   public <T> void method1() {} // OK
   public <a> void method2() {} // OK
   public <K, V> void method3() {} // OK
   public <k, V> void method4() {} // OK
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • name.invalidPattern
    Since:
    5.0

    • Constructor Detail

      • MethodTypeParameterNameCheck

        public MethodTypeParameterNameCheck()
        Creates a new MethodTypeParameterNameCheck instance.

    • Method Detail

      • 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:
        TokenTypes

      • getAcceptableTokens

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

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