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

Class AnonInnerLengthCheck

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

    Checks for long anonymous inner classes.

    Rationale: If an anonymous inner class becomes very long it is hard to understand and to see the flow of the method where the class is defined. Therefore long anonymous inner classes should usually be refactored into a named inner class. See also Bloch, Effective Java, p. 93.

    • Property max - Specify the maximum number of lines allowed. Type is int. Default value is 20.

    To configure the check to accept anonymous classes with up to 20 lines: 

     <module name="AnonInnerLength"/>

    To configure the check to accept anonymous classes with up to 60 lines: 

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

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • maxLen.anonInner
    Since:
    3.2

    • 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

      • AnonInnerLengthCheck

        public AnonInnerLengthCheck()

    • 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)
        Setter to specify the maximum number of lines allowed.
        Parameters:
        length - the maximum length of an anonymous inner class.