001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 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 class definitions.
027 *
028 */
029public class ClassDefHandler extends BlockParentHandler {
030
031    /**
032     * Construct an instance of this handler with the given indentation check,
033     * abstract syntax tree, and parent handler.
034     *
035     * @param indentCheck   the indentation check
036     * @param ast           the abstract syntax tree
037     * @param parent        the parent handler
038     */
039    public ClassDefHandler(IndentationCheck indentCheck,
040                           DetailAST ast,
041                           AbstractExpressionHandler parent) {
042        super(indentCheck, getHandlerName(ast), ast, parent);
043    }
044
045    @Override
046    protected DetailAST getLeftCurly() {
047        return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
048            .findFirstToken(TokenTypes.LCURLY);
049    }
050
051    @Override
052    protected DetailAST getRightCurly() {
053        return getMainAst().findFirstToken(TokenTypes.OBJBLOCK)
054            .findFirstToken(TokenTypes.RCURLY);
055    }
056
057    @Override
058    protected DetailAST getTopLevelAst() {
059        return null;
060        // note: ident checked by hand in check indentation;
061    }
062
063    @Override
064    protected DetailAST getListChild() {
065        return getMainAst().findFirstToken(TokenTypes.OBJBLOCK);
066    }
067
068    @Override
069    public void checkIndentation() {
070        final DetailAST modifiers = getMainAst().findFirstToken(TokenTypes.MODIFIERS);
071        if (modifiers.hasChildren()) {
072            checkModifiers();
073        }
074        else {
075            if (getMainAst().getType() != TokenTypes.ANNOTATION_DEF) {
076                final DetailAST ident = getMainAst().findFirstToken(TokenTypes.IDENT);
077                DetailAST tokenToCheck = getMainAst();
078                if (ident.getLineNo() == getMainAst().getLineNo()) {
079                    tokenToCheck = ident;
080                }
081                final int lineStart = getLineStart(tokenToCheck);
082                if (!getIndent().isAcceptable(lineStart)) {
083                    logError(tokenToCheck, "ident", lineStart);
084                }
085            }
086        }
087        if (getMainAst().getType() == TokenTypes.ANNOTATION_DEF) {
088            final DetailAST atAst = getMainAst().findFirstToken(TokenTypes.AT);
089            if (isOnStartOfLine(atAst)) {
090                checkWrappingIndentation(getMainAst(), getListChild(), 0,
091                        getIndent().getFirstIndentLevel(), false);
092            }
093        }
094        else {
095            checkWrappingIndentation(getMainAst(), getListChild());
096        }
097        super.checkIndentation();
098    }
099
100    @Override
101    protected int[] getCheckedChildren() {
102        return new int[] {
103            TokenTypes.EXPR,
104            TokenTypes.OBJBLOCK,
105            TokenTypes.LITERAL_BREAK,
106            TokenTypes.LITERAL_RETURN,
107            TokenTypes.LITERAL_THROW,
108            TokenTypes.LITERAL_CONTINUE,
109        };
110    }
111
112    /**
113     * Creates a handler name for this class according to ast type.
114     *
115     * @param ast the abstract syntax tree.
116     * @return handler name for this class.
117     */
118    private static String getHandlerName(DetailAST ast) {
119        final int tokenType = ast.getType();
120
121        return switch (tokenType) {
122            case TokenTypes.CLASS_DEF -> "class def";
123            case TokenTypes.ENUM_DEF -> "enum def";
124            case TokenTypes.ANNOTATION_DEF -> "annotation def";
125            case TokenTypes.RECORD_DEF -> "record def";
126            default -> "interface def";
127        };
128    }
129
130}