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.TokenUtil;
027
028/**
029 * <div>
030 * Checks if unnecessary semicolon is used in last resource declaration.
031 * </div>
032 *
033 * @since 8.22
034 */
035@StatelessCheck
036public final class UnnecessarySemicolonInTryWithResourcesCheck extends AbstractCheck {
037
038    /**
039     * A key is pointing to the warning message text in "messages.properties" file.
040     */
041    public static final String MSG_SEMI = "unnecessary.semicolon";
042
043    /** Allow unnecessary semicolon if closing parenthesis is not on the same line. */
044    private boolean allowWhenNoBraceAfterSemicolon = true;
045
046    /**
047     * Creates a new {@code UnnecessarySemicolonInTryWithResourcesCheck} instance.
048     */
049    public UnnecessarySemicolonInTryWithResourcesCheck() {
050        // no code by default
051    }
052
053    @Override
054    public int[] getDefaultTokens() {
055        return getRequiredTokens();
056    }
057
058    @Override
059    public int[] getAcceptableTokens() {
060        return getRequiredTokens();
061    }
062
063    @Override
064    public int[] getRequiredTokens() {
065        return new int[] {
066            TokenTypes.RESOURCE_SPECIFICATION,
067        };
068    }
069
070    /**
071     * Setter to allow unnecessary semicolon if closing parenthesis is not on the same line.
072     *
073     * @param allowWhenNoBraceAfterSemicolon a value to set.
074     * @since 8.22
075     */
076    public void setAllowWhenNoBraceAfterSemicolon(boolean allowWhenNoBraceAfterSemicolon) {
077        this.allowWhenNoBraceAfterSemicolon = allowWhenNoBraceAfterSemicolon;
078    }
079
080    @Override
081    public void visitToken(DetailAST ast) {
082        final DetailAST closingParen = ast.getLastChild();
083        final DetailAST tokenBeforeCloseParen = closingParen.getPreviousSibling();
084        if (tokenBeforeCloseParen.getType() == TokenTypes.SEMI
085            && (!allowWhenNoBraceAfterSemicolon
086                || TokenUtil.areOnSameLine(closingParen, tokenBeforeCloseParen))) {
087            log(tokenBeforeCloseParen, MSG_SEMI);
088        }
089    }
090
091}