1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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
27 /**
28 * <div>
29 * Checks if unnecessary semicolon is in enum definitions.
30 * Semicolon is not needed if enum body contains only enum constants.
31 * </div>
32 *
33 * <p>
34 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
35 * </p>
36 *
37 * <p>
38 * Violation Message Keys:
39 * </p>
40 * <ul>
41 * <li>
42 * {@code unnecessary.semicolon}
43 * </li>
44 * </ul>
45 *
46 * @since 8.22
47 */
48 @StatelessCheck
49 public final class UnnecessarySemicolonInEnumerationCheck extends AbstractCheck {
50
51 /**
52 * A key is pointing to the warning message text in "messages.properties"
53 * file.
54 */
55 public static final String MSG_SEMI = "unnecessary.semicolon";
56
57 @Override
58 public int[] getDefaultTokens() {
59 return getRequiredTokens();
60 }
61
62 @Override
63 public int[] getAcceptableTokens() {
64 return getRequiredTokens();
65 }
66
67 @Override
68 public int[] getRequiredTokens() {
69 return new int[] {
70 TokenTypes.ENUM_DEF,
71 };
72 }
73
74 @Override
75 public void visitToken(DetailAST ast) {
76 final DetailAST enumBlock = ast.findFirstToken(TokenTypes.OBJBLOCK);
77 final DetailAST semicolon = enumBlock.findFirstToken(TokenTypes.SEMI);
78 if (semicolon != null && isEndOfEnumerationAfter(semicolon)) {
79 log(semicolon, MSG_SEMI);
80 }
81 }
82
83 /**
84 * Checks if enum body has no code elements after enum constants semicolon.
85 *
86 * @param ast semicolon in enum constants definition end
87 * @return true if there is no code elements, false otherwise.
88 */
89 private static boolean isEndOfEnumerationAfter(DetailAST ast) {
90 return ast.getNextSibling().getType() == TokenTypes.RCURLY;
91 }
92 }