Class ClassTypeParameterNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class ClassTypeParameterNameCheck
    extends AbstractNameCheck

    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
    • Method Detail

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