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

Class NestedForDepthCheck

java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.coding.NestedForDepthCheck
All Implemented Interfaces:
Configurable, Contextualizable
public final class NestedForDepthCheck extends AbstractCheck

Restricts nested for 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="NestedForDepth"/>

Example:

 for(int i=0; i<10; i++) {
   for(int j=0; j<i; j++) {
     for(int k=0; k<j; k++) { // violation, max allowed nested loop number is 1
     }
   }
 }

 for(int i=0; i<10; i++) {
   for(int j=0; j<i; j++) { // ok
   }
 }

To configure the check to allow nesting depth 2: 

 <module name="NestedForDepth">
   <property name="max" value="2"/>
 </module>

Example:

 for(int i=0; i<10; i++) {
   for(int j=0; j<i; j++) {
     for(int k=0; k<j; k++) {
       for(int l=0; l<k; l++) { // violation, max allowed nested loop number is 2
       }
     }
    }
 }

 for(int i=0; i<10; i++) {
   for(int j=0; j<i; j++) {
     for(int k=0; k<j; k++) { // ok
     }
   }
 }

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • nested.for.depth
Since:
5.3

  • Field Details

    • MSG_KEY

      public static final String MSG_KEY
      A key is pointing to the warning message text in "messages.properties" file.
      See Also:

    • max

      private int max
      Specify maximum allowed nesting depth.

    • depth

      private int depth
      Current nesting depth.

  • Constructor Details

    • NestedForDepthCheck

      public NestedForDepthCheck()

  • Method Details

    • setMax

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

    • 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:

    • 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:

    • 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:

    • 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

    • visitToken

      public void visitToken(DetailAST ast)
      Description copied from class: AbstractCheck
      Called to process a token.
      Overrides:
      visitToken in class AbstractCheck
      Parameters:
      ast - the token to process

    • 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