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.coding;
021
022import com.puppycrawl.tools.checkstyle.StatelessCheck;
023import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
027import com.puppycrawl.tools.checkstyle.utils.ScopeUtil;
028
029/**
030 * <div>
031 * Checks if unnecessary semicolon is used after type declaration.
032 * </div>
033 *
034 * <p>
035 * Notes:
036 * This check is not applicable to nested type declarations,
037 * <a
038 * href="https://checkstyle.org/checks/coding/unnecessarysemicolonaftertypememberdeclaration.html">
039 * UnnecessarySemicolonAfterTypeMemberDeclaration</a> is responsible for it.
040 * </p>
041 *
042 * @since 8.31
043 */
044@StatelessCheck
045public final class UnnecessarySemicolonAfterOuterTypeDeclarationCheck extends AbstractCheck {
046
047    /**
048     * A key is pointing to the warning message text in "messages.properties"
049     * file.
050     */
051    public static final String MSG_SEMI = "unnecessary.semicolon";
052
053    @Override
054    public int[] getDefaultTokens() {
055        return getAcceptableTokens();
056    }
057
058    @Override
059    public int[] getAcceptableTokens() {
060        return new int[] {
061            TokenTypes.CLASS_DEF,
062            TokenTypes.INTERFACE_DEF,
063            TokenTypes.ENUM_DEF,
064            TokenTypes.ANNOTATION_DEF,
065            TokenTypes.RECORD_DEF,
066        };
067    }
068
069    @Override
070    public int[] getRequiredTokens() {
071        return CommonUtil.EMPTY_INT_ARRAY;
072    }
073
074    @Override
075    public void visitToken(DetailAST ast) {
076        final DetailAST nextSibling = ast.getNextSibling();
077        if (nextSibling != null
078                && ScopeUtil.isOuterMostType(ast)
079                && nextSibling.getType() == TokenTypes.SEMI) {
080            log(nextSibling, MSG_SEMI);
081        }
082    }
083}