View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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.indentation;
21  
22  import com.puppycrawl.tools.checkstyle.api.DetailAST;
23  import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24  import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
25  
26  /**
27   * Handler for switch statements.
28   *
29   */
30  public class SwitchHandler extends BlockParentHandler {
31  
32      /**
33       * Construct an instance of this handler with the given indentation check,
34       * abstract syntax tree, and parent handler.
35       *
36       * @param indentCheck   the indentation check
37       * @param ast           the abstract syntax tree
38       * @param parent        the parent handler
39       */
40      public SwitchHandler(IndentationCheck indentCheck,
41          DetailAST ast, AbstractExpressionHandler parent) {
42          super(indentCheck, "switch", ast, parent);
43      }
44  
45      @Override
46      protected DetailAST getLeftCurly() {
47          return getMainAst().findFirstToken(TokenTypes.LCURLY);
48      }
49  
50      @Override
51      protected DetailAST getRightCurly() {
52          return getMainAst().findFirstToken(TokenTypes.RCURLY);
53      }
54  
55      @Override
56      protected DetailAST getListChild() {
57          // all children should be taken care of by case handler (plus
58          // there is no parent of just the cases, if checking is needed
59          // here in the future, an additional way beyond checkChildren()
60          // will have to be devised to get children)
61          return null;
62      }
63  
64      @Override
65      protected DetailAST getNonListChild() {
66          return null;
67      }
68  
69      /**
70       * Check the indentation of the switch expression.
71       */
72      private void checkSwitchExpr() {
73          checkExpressionSubtree(
74              getMainAst().findFirstToken(TokenTypes.LPAREN).getNextSibling(),
75              getIndent(),
76              false,
77              false);
78      }
79  
80      @Override
81      protected IndentLevel getIndentImpl() {
82          IndentLevel indentLevel = super.getIndentImpl();
83          // if switch is starting the line
84          if (isOnStartOfLine(getMainAst())
85                  && TokenUtil.isOfType(getMainAst().getParent().getParent(), TokenTypes.ASSIGN)) {
86              indentLevel = new IndentLevel(indentLevel,
87                      getIndentCheck().getLineWrappingIndentation());
88          }
89          return indentLevel;
90      }
91  
92      @Override
93      public void checkIndentation() {
94          checkSwitchExpr();
95          super.checkIndentation();
96      }
97  
98  }