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

Class NestedIfDepthCheck

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

    Restricts nested if-else blocks to a specified depth.

    • Property max - Specify maximum allowed nesting depth. Type is int. Default value is 1.

    To configure the check: 

     <module name="NestedIfDepth"/>

    Valid code example:

     if (true) {
     if (true) {} // OK
     else {}
 }

    Invalid code example:

     if (true) {
     if (true) {
         if (true) { // violation, nested if-else depth is 2 (max allowed is 1)
         }
     }
 }

    To configure the check to allow nesting depth 3: 

     <module name="NestedIfDepth">
   <property name="max" value="3"/>
 </module>

    Valid code example:

     if (true) {
    if (true) {
       if (true) {
          if (true) {} // OK
          else {}
       }
    }
 }

    Invalid code example:

     if (true) {
    if (true) {
       if (true) {
          if (true) {
             if (true) { // violation, nested if-else depth is 4 (max allowed is 3)
                if (true) {} // violation, nested if-else depth is 5 (max allowed is 3)
                else {}
             }
          }
       }
    }
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • nested.if.depth
    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

      • max

        private int max
        Specify maximum allowed nesting depth.

      • depth

        private int depth
        Current nesting depth.

    • Method Detail

      • setMax

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

      • 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

      • 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