1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2025 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.coding;
21
22 import com.puppycrawl.tools.checkstyle.StatelessCheck;
23 import com.puppycrawl.tools.checkstyle.api.AbstractCheck;
24 import com.puppycrawl.tools.checkstyle.api.DetailAST;
25 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
26 import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
27
28 /**
29 * <div>
30 * Checks if unnecessary semicolon is used in last resource declaration.
31 * </div>
32 *
33 * @since 8.22
34 */
35 @StatelessCheck
36 public final class UnnecessarySemicolonInTryWithResourcesCheck extends AbstractCheck {
37
38 /**
39 * A key is pointing to the warning message text in "messages.properties"
40 * file.
41 */
42 public static final String MSG_SEMI = "unnecessary.semicolon";
43
44 /** Allow unnecessary semicolon if closing parenthesis is not on the same line. */
45 private boolean allowWhenNoBraceAfterSemicolon = true;
46
47 @Override
48 public int[] getDefaultTokens() {
49 return getRequiredTokens();
50 }
51
52 @Override
53 public int[] getAcceptableTokens() {
54 return getRequiredTokens();
55 }
56
57 @Override
58 public int[] getRequiredTokens() {
59 return new int[] {
60 TokenTypes.RESOURCE_SPECIFICATION,
61 };
62 }
63
64 /**
65 * Setter to allow unnecessary semicolon if closing parenthesis is not on the same line.
66 *
67 * @param allowWhenNoBraceAfterSemicolon a value to set.
68 * @since 8.22
69 */
70 public void setAllowWhenNoBraceAfterSemicolon(boolean allowWhenNoBraceAfterSemicolon) {
71 this.allowWhenNoBraceAfterSemicolon = allowWhenNoBraceAfterSemicolon;
72 }
73
74 @Override
75 public void visitToken(DetailAST ast) {
76 final DetailAST closingParen = ast.getLastChild();
77 final DetailAST tokenBeforeCloseParen = closingParen.getPreviousSibling();
78 if (tokenBeforeCloseParen.getType() == TokenTypes.SEMI
79 && (!allowWhenNoBraceAfterSemicolon
80 || TokenUtil.areOnSameLine(closingParen, tokenBeforeCloseParen))) {
81 log(tokenBeforeCloseParen, MSG_SEMI);
82 }
83 }
84
85 }