Class ParameterNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class ParameterNameCheck
    extends AbstractNameCheck

    Checks that method and catch parameter names conform to a format specified by the format property. The format is a regular expression and defaults to ^[a-z][a-zA-Z0-9]*$.

    The check has the following options:

    ignoreOverridden - allows to skip methods with Override annotation from validation. Default values is false .

    accessModifiers - access modifiers of methods which should to be checked. Default value is public, protected, package, private .

    An example of how to configure the check:
     <module name="ParameterName"/>
     

    An example of how to configure the check for names that begin with a lower case letter, followed by letters, digits, and underscores:

     <module name="ParameterName">
        <property name="format" value="^[a-z][_a-zA-Z0-9]+$"/>
     </module>
     

    An example of how to configure the check to skip methods with Override annotation from validation:

     <module name="ParameterName">
        <property name="ignoreOverridden" value="true"/>
     </module>
     
    Author:
    Oliver Burn, Andrei Selkin
    • Constructor Detail

      • ParameterNameCheck

        public ParameterNameCheck()
        Creates a new ParameterNameCheck instance.
    • Method Detail

      • setIgnoreOverridden

        public void setIgnoreOverridden​(boolean ignoreOverridden)
        Sets whether to skip methods with Override annotation from validation.
        Parameters:
        ignoreOverridden - Flag for skipping methods with Override annotation.
      • setAccessModifiers

        public void setAccessModifiers​(AccessModifier... accessModifiers)
        Sets access modifiers of methods which should be checked.
        Parameters:
        accessModifiers - access modifiers of methods which should be checked.
      • 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.