Package com.puppycrawl.tools.checkstyle.checks.coding

Class OverloadMethodsDeclarationOrderCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class OverloadMethodsDeclarationOrderCheck
extends AbstractCheck

    Checks that overloaded methods are grouped together. Overloaded methods have the same name but different signatures where the signature can differ by the number of input parameters or type of input parameters or both.

    To configure the check: 

     <module name="OverloadMethodsDeclarationOrder"/>

    Example of correct grouping of overloaded methods: 

     public void foo(int i) {}
 public void foo(String s) {}
 public void foo(String s, int i) {}
 public void foo(int i, String s) {}
 public void notFoo() {}

    Example of incorrect grouping of overloaded methods: 

     public void foo(int i) {} // OK
 public void foo(String s) {} // OK
 public void notFoo() {} // violation. Have to be after foo(String s, int i)
 public void foo(int i, String s) {}
 public void foo(String s, int i) {}

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • overload.methods.declaration
    Since:
    5.8

    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • OverloadMethodsDeclarationOrderCheck

        public OverloadMethodsDeclarationOrderCheck()

    • Method Detail

      • getDefaultTokens

        public int[] getDefaultTokens()
        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 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

      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes