1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2026 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 /**
48 * Creates a new {@code UnnecessarySemicolonInTryWithResourcesCheck} instance.
49 */
50 public UnnecessarySemicolonInTryWithResourcesCheck() {
51 // no code by default
52 }
53
54 @Override
55 public int[] getDefaultTokens() {
56 return getRequiredTokens();
57 }
58
59 @Override
60 public int[] getAcceptableTokens() {
61 return getRequiredTokens();
62 }
63
64 @Override
65 public int[] getRequiredTokens() {
66 return new int[] {
67 TokenTypes.RESOURCE_SPECIFICATION,
68 };
69 }
70
71 /**
72 * Setter to allow unnecessary semicolon if closing parenthesis is not on the same line.
73 *
74 * @param allowWhenNoBraceAfterSemicolon a value to set.
75 * @since 8.22
76 */
77 public void setAllowWhenNoBraceAfterSemicolon(boolean allowWhenNoBraceAfterSemicolon) {
78 this.allowWhenNoBraceAfterSemicolon = allowWhenNoBraceAfterSemicolon;
79 }
80
81 @Override
82 public void visitToken(DetailAST ast) {
83 final DetailAST closingParen = ast.getLastChild();
84 final DetailAST tokenBeforeCloseParen = closingParen.getPreviousSibling();
85 if (tokenBeforeCloseParen.getType() == TokenTypes.SEMI
86 && (!allowWhenNoBraceAfterSemicolon
87 || TokenUtil.areOnSameLine(closingParen, tokenBeforeCloseParen))) {
88 log(tokenBeforeCloseParen, MSG_SEMI);
89 }
90 }
91
92 }