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

Class OverloadMethodsDeclarationOrderCheck

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

    Checks that overload methods are grouped together. Example: 

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

    An example of how to configure the check is: 

     <module name="OverloadMethodsDeclarationOrder"/>

    • 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

      • checkOverloadMethodsGrouping

        private void checkOverloadMethodsGrouping​(DetailAST objectBlock)
        Checks that if overload methods are grouped together they should not be separated from each other.
        Parameters:
        objectBlock - is a class, interface or enum object block.