1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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.utils.TokenUtil;
24
25 /**
26 * Handler for yield expression.
27 */
28 public class YieldHandler extends AbstractExpressionHandler {
29
30 /**
31 * Construct an instance of this handler with the given indentation check,
32 * abstract syntax tree, and parent handler.
33 *
34 * @param indentCheck the indentation check
35 * @param ast the abstract syntax tree
36 * @param parent the parent handler
37 */
38 public YieldHandler(IndentationCheck indentCheck,
39 DetailAST ast,
40 AbstractExpressionHandler parent) {
41 super(indentCheck, "yield", ast, parent);
42 }
43
44 @Override
45 public void checkIndentation() {
46 checkYield();
47 final DetailAST expression = getMainAst().getFirstChild();
48 if (!TokenUtil.areOnSameLine(getMainAst(), expression)) {
49 checkExpressionSubtree(expression, getIndent(), false, false);
50 }
51 }
52
53 /**
54 * Check the indentation of the yield keyword.
55 */
56 private void checkYield() {
57 final DetailAST yieldKey = getMainAst();
58 final int columnNo = expandedTabsColumnNo(yieldKey);
59 if (isOnStartOfLine(yieldKey) && !getIndent().isAcceptable(columnNo)) {
60 logError(yieldKey, "", columnNo);
61 }
62 }
63 }