View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2026 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ///////////////////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.checks.coding;
21  
22  import com.puppycrawl.tools.checkstyle.FileStatefulCheck;
23  import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24  import com.puppycrawl.tools.checkstyle.api.DetailAST;
25  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
26  
27  /**
28   * <div>
29   * Restricts nested {@code for} blocks to a specified depth.
30   * </div>
31   *
32   * @since 5.3
33   */
34  @FileStatefulCheck
35  public final class NestedForDepthCheck extends AbstractCheck {
36  
37      /**
38       * A key is pointing to the warning message text in "messages.properties" file.
39       */
40      public static final String MSG_KEY = "nested.for.depth";
41  
42      /** Specify maximum allowed nesting depth. */
43      private int max = 1;
44      /** Current nesting depth. */
45      private int depth;
46  
47      /**
48       * Creates a new {@code NestedForDepthCheck} instance.
49       */
50      public NestedForDepthCheck() {
51          // no code by default
52      }
53  
54      /**
55       * Setter to specify maximum allowed nesting depth.
56       *
57       * @param max maximum allowed nesting depth.
58       * @since 5.3
59       */
60      public void setMax(int max) {
61          this.max = max;
62      }
63  
64      @Override
65      public int[] getDefaultTokens() {
66          return getRequiredTokens();
67      }
68  
69      @Override
70      public int[] getAcceptableTokens() {
71          return getRequiredTokens();
72      }
73  
74      @Override
75      public int[] getRequiredTokens() {
76          return new int[] {TokenTypes.LITERAL_FOR};
77      }
78  
79      @Override
80      public void beginTree(DetailAST rootAST) {
81          depth = 0;
82      }
83  
84      @Override
85      public void visitToken(DetailAST ast) {
86          if (depth > max) {
87              log(ast, MSG_KEY, depth, max);
88          }
89          ++depth;
90      }
91  
92      @Override
93      public void leaveToken(DetailAST ast) {
94          --depth;
95      }
96  
97  }