Package com.puppycrawl.tools.checkstyle.checks.sizes

Class MethodLengthCheck

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

    Checks for long methods.

    Rationale: If a method becomes very long it is hard to understand. Therefore long methods should usually be refactored into several individual methods that focus on a specific task.

    The default maximum method length is 150 lines. To change the maximum number of lines, set property max.

    An example of how to configure the check is: 

     <module name="MethodLength"/>

    An example of how to configure the check so that it accepts methods with at most 60 lines is: 

     <module name="MethodLength">
    <property name="max" value="60"/>
 </module>

    • 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

      • MethodLengthCheck

        public MethodLengthCheck()

    • 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

      • setMax

        public void setMax​(int length)
        Sets maximum length of a method.
        Parameters:
        length - the maximum length of a method.

      • setCountEmpty

        public void setCountEmpty​(boolean countEmpty)
        Sets countEmpty.
        Parameters:
        countEmpty - whether to count empty and single line comments of the form //.