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