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

Class AbstractTypeParameterNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    @Deprecated
public abstract class AbstractTypeParameterNameCheck
extends AbstractNameCheck
    Deprecated.
    Checkstyle will not support abstract checks anymore. Use AbstractNameCheck instead.

    Abstract class for checking if a class/method type parameter's name conforms to a format specified by the format property.

    This class extends AbstractNameCheck

    • Constructor Detail

      • AbstractTypeParameterNameCheck

        protected AbstractTypeParameterNameCheck​(java.lang.String format)
        Deprecated.
        Creates a new AbstractTypeParameterNameCheck instance.
        Parameters:
        format - format to check with

    • Method Detail

      • getLocation

        protected abstract int getLocation()
        Deprecated.
        This method must be overridden to specify the location of the type parameter to check.
        Returns:
        TokenTypes.CLASS_DEF or TokenTypes.METHOD_DEF

      • getDefaultTokens

        public final int[] getDefaultTokens()
        Deprecated.
        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 final int[] getAcceptableTokens()
        Deprecated.
        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)
        Deprecated.
        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.