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

Class MethodNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class MethodNameCheck
extends AbstractAccessControlNameCheck
    Checks that method names conform to a specified pattern.

    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.

    • Property allowClassName - Control whether to allow a method name to have the same name as the enclosing class name. Setting this property false helps to avoid confusion between constructors and methods. Type is boolean. Default value is false.
    • Property applyToPackage - Control if check should apply to package-private members. Type is boolean. Default value is true.
    • Property applyToPrivate - Control if check should apply to private members. Type is boolean. Default value is true.
    • Property applyToProtected - Control if check should apply to protected members. Type is boolean. Default value is true.
    • Property applyToPublic - Control if check should apply to public members. Type is boolean. Default value is true.
    • Property format - Sets the pattern to match valid identifiers. Type is java.util.regex.Pattern. Default value is "^[a-z][a-zA-Z0-9]*$".

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • method.name.equals.class.name
    • name.invalidPattern
    Since:
    3.0

    • Field Detail

      • allowClassName

        private boolean allowClassName
        Control whether to allow a method name to have the same name as the enclosing class name. Setting this property false helps to avoid confusion between constructors and methods.

    • 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)
        Setter to control whether to allow a method name to have the same name as the enclosing class name. Setting this property false helps to avoid confusion between constructors and methods.
        Parameters:
        allowClassName - true to allow false to disallow
        Since:
        5.0