Class MethodCountCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public final class MethodCountCheck
    extends AbstractCheck
    Checks the number of methods declared in each type declaration by access modifier or total count.
    • Field Detail

      • MSG_PRIVATE_METHODS

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

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

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

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

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

      • MethodCountCheck

        public MethodCountCheck()
    • 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
      • leaveToken

        public void leaveToken​(DetailAST ast)
        Description copied from class: AbstractCheck
        Called after all the child nodes have been process.
        Overrides:
        leaveToken in class AbstractCheck
        Parameters:
        ast - the token leaving
      • setMaxPrivate

        public void setMaxPrivate​(int value)
        Sets the maximum allowed private methods per type.
        Parameters:
        value - the maximum allowed.
      • setMaxPackage

        public void setMaxPackage​(int value)
        Sets the maximum allowed package methods per type.
        Parameters:
        value - the maximum allowed.
      • setMaxProtected

        public void setMaxProtected​(int value)
        Sets the maximum allowed protected methods per type.
        Parameters:
        value - the maximum allowed.
      • setMaxPublic

        public void setMaxPublic​(int value)
        Sets the maximum allowed public methods per type.
        Parameters:
        value - the maximum allowed.
      • setMaxTotal

        public void setMaxTotal​(int value)
        Sets the maximum total methods per type.
        Parameters:
        value - the maximum allowed.