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

Class CatchParameterNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class CatchParameterNameCheck
extends AbstractNameCheck
    Checks that catch parameter names conform to a specified pattern.

    Default pattern has the following characteristic:

    • allows names beginning with two lowercase letters followed by at least one uppercase or lowercase letter
    • allows e abbreviation (suitable for exceptions end errors)
    • allows ex abbreviation (suitable for exceptions)
    • allows t abbreviation (suitable for throwables)
    • allows _ for unnamed catch parameters
    • prohibits numbered abbreviations like e1 or t2
    • prohibits one letter prefixes like pException
    • prohibits two letter abbreviations like ie or ee
    • prohibits any other characters than letters
    • Property format - Sets the pattern to match valid identifiers. Type is java.util.regex.Pattern. Default value is "^(e|t|ex|[a-z][a-z][a-zA-Z]+|_)$".

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • name.invalidPattern
    Since:
    6.14

    • Constructor Detail

    • Method Detail

      • 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

      • mustCheckName

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