Class MethodNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class MethodNameCheck
    extends AbstractAccessControlNameCheck

    Checks that method 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]*$.

    Also, checks if a method name has the same name as the residing class. The default is false (it is not allowed). It is legal in Java to have method with the same name as a class. As long as a return type is specified it is a method and not a constructor which it could be easily confused as.

    Does not check-style the name of an overridden methods

    because the developer does not have a choice in renaming such methods.

    An example of how to configure the check is:

     <module name="MethodName"/>
     

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

     <module name="MethodName">
        <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
     </module>
     

    An example of how to configure the check to allow method names to be equal to the residing class name is:

     <module name="MethodName">
        <property name="allowClassName" value="true"/>
     </module>
     
    Author:
    Oliver Burn, Travis Schneeberger, Utkarsh Srivastava
    • Constructor Detail

      • MethodNameCheck

        public MethodNameCheck()
        Creates a new MethodNameCheck instance.
    • 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
      • setAllowClassName

        public void setAllowClassName​(boolean allowClassName)
        Sets the property for allowing a method to be the same name as a class.
        Parameters:
        allowClassName - true to allow false to disallow