001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.indentation;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * Handler for synchronized statements.
027 *
028 */
029public class SynchronizedHandler extends BlockParentHandler {
030
031    /**
032     * Determine that "synchronized" token used as modifier of method.
033     */
034    private final boolean methodModifier;
035
036    /**
037     * Construct an instance of this handler with the given indentation check,
038     * name, abstract syntax tree, and parent handler.
039     *
040     * @param indentCheck the indentation check
041     * @param ast         the abstract syntax tree
042     * @param parent      the parent handler
043     */
044    public SynchronizedHandler(IndentationCheck indentCheck, DetailAST ast,
045                               AbstractExpressionHandler parent) {
046        super(indentCheck, "synchronized", ast, parent);
047        methodModifier = isMethodModifier(ast);
048    }
049
050    @Override
051    public void checkIndentation() {
052        if (!methodModifier) {
053            super.checkIndentation();
054            checkSynchronizedExpr();
055            checkWrappingIndentation(getMainAst(),
056                    getSynchronizedStatementRightParen(getMainAst()));
057        }
058    }
059
060    /**
061     * Check indentation of expression we synchronized on.
062     */
063    private void checkSynchronizedExpr() {
064        final DetailAST syncAst = getMainAst().findFirstToken(TokenTypes.LPAREN)
065                .getNextSibling();
066        final IndentLevel expected =
067                new IndentLevel(getIndent(), getBasicOffset());
068        checkExpressionSubtree(syncAst, expected, false, false);
069    }
070
071    /**
072     * Checks if given synchronized is modifier of method.
073     *
074     * @param ast synchronized(TokenTypes.LITERAL_SYNCHRONIZED) to check
075     * @return true if synchronized only modifies method
076     */
077    private static boolean isMethodModifier(DetailAST ast) {
078        return ast.getParent().getType() == TokenTypes.MODIFIERS;
079    }
080
081    /**
082     * Returns right parenthesis of synchronized statement.
083     *
084     * @param syncStatementAST ast node(TokenTypes.LITERAL_SYNCHRONIZED)
085     * @return right parenthesis of synchronized statement.
086     */
087    private static DetailAST getSynchronizedStatementRightParen(DetailAST syncStatementAST) {
088        return syncStatementAST.findFirstToken(TokenTypes.RPAREN);
089    }
090
091}