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

Class ExecutableStatementCountCheck

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

    Restricts the number of executable statements to a specified limit.

    To configure the check: 

     <module name="ExecutableStatementCount"/>

    To configure the check with a threshold of 20 for constructor and method definitions: 

     <module name="ExecutableStatementCount">
   <property name="max" value="20"/>
   <property name="tokens" value="CTOR_DEF,METHOD_DEF"/>
 </module>

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • executableStatementCount
    Since:
    3.2

    • Method Detail

      • 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

      • setMax

        public void setMax​(int max)
        Setter to specify the maximum threshold allowed.
        Parameters:
        max - the maximum threshold.

      • beginTree

        public void beginTree​(DetailAST rootAST)
        Description copied from class: AbstractCheck
        Called before the starting to process a tree. Ideal place to initialize information that is to be collected whilst processing a tree.
        Overrides:
        beginTree in class AbstractCheck
        Parameters:
        rootAST - the root of the tree

      • visitContainerNode

        private void visitContainerNode​(DetailAST ast)
        Process the start of the container node.
        Parameters:
        ast - the token representing the container node.

      • leaveContainerNode

        private void leaveContainerNode​(DetailAST ast)
        Process the end of a container node.
        Parameters:
        ast - the token representing the container node.

      • visitSlist

        private void visitSlist​(DetailAST ast)
        Process the end of a statement list.
        Parameters:
        ast - the token representing the statement list.

      • isContainerNode

        private static boolean isContainerNode​(DetailAST node)
        Check if the node is of type ctor (compact or canonical), instance/ static initializer, method definition or lambda.
        Parameters:
        node - AST node we are checking
        Returns:
        true if node is of the given types