KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > puppycrawl > tools > checkstyle > checks > indentation > ForHandler


1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2005 Oliver Burn
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 package com.puppycrawl.tools.checkstyle.checks.indentation;
20
21 import com.puppycrawl.tools.checkstyle.api.DetailAST;
22 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
23
24 /**
25  * Handler for for loops.
26  *
27  * @author jrichard
28  */
29 public class ForHandler extends BlockParentHandler
30 {
31     /**
32      * Construct an instance of this handler with the given indentation check,
33      * abstract syntax tree, and parent handler.
34      *
35      * @param aIndentCheck the indentation check
36      * @param aAst the abstract syntax tree
37      * @param aParent the parent handler
38      */
39     public ForHandler(IndentationCheck aIndentCheck,
40         DetailAST aAst, ExpressionHandler aParent)
41     {
42         super(aIndentCheck, "for", aAst, aParent);
43     }
44
45     /**
46      * Check the indentation of the parameters of the 'for' loop.
47      */
48     private void checkForParams()
49     {
50         final IndentLevel expected =
51             new IndentLevel(getLevel(), getBasicOffset());
52         final DetailAST init = getMainAst().findFirstToken(TokenTypes.FOR_INIT);
53
54         if (init != null) {
55             checkExpressionSubtree(init, expected, false, false);
56
57             final DetailAST cond =
58                 getMainAst().findFirstToken(TokenTypes.FOR_CONDITION);
59             checkExpressionSubtree(cond, expected, false, false);
60
61             final DetailAST iter =
62                 getMainAst().findFirstToken(TokenTypes.FOR_ITERATOR);
63             checkExpressionSubtree(iter, expected, false, false);
64         }
65         // for each
66 else {
67             final DetailAST forEach =
68                 getMainAst().findFirstToken(TokenTypes.FOR_EACH_CLAUSE);
69             checkExpressionSubtree(forEach, expected, false, false);
70         }
71     }
72
73     /**
74      * Check the indentation of the expression we are handling.
75      */
76     public void checkIndentation()
77     {
78         checkForParams();
79         super.checkIndentation();
80     }
81
82     /**
83      * Indentation level suggested for a child element. Children don't have
84      * to respect this, but most do.
85      *
86      * @param aChild child AST (so suggestion level can differ based on child
87      * type)
88      *
89      * @return suggested indentation for child
90      */
91     public IndentLevel suggestedChildLevel(ExpressionHandler aChild)
92     {
93         if (aChild instanceof ElseHandler) {
94             return getLevel();
95         }
96         return super.suggestedChildLevel(aChild);
97     }
98 }
99
Popular Tags