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.design;
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 that sealed classes and interfaces have a permits list.
30 * </div>
31 *
32 * <p>
33 * Rationale: When a permits clause is omitted from a sealed class,
34 * any class within the same compilation unit can extend it. This differs
35 * from other sealed classes where permitted subclasses are explicitly
36 * declared, making them readily visible to the reader. Without a permits
37 * clause, identifying potential subclasses requires searching the entire
38 * compilation unit, which can be challenging, especially in large files
39 * with complex class hierarchies.
40 * </p>
41 *
42 * <p>
43 * See the <a href="https://docs.oracle.com/javase/specs/jls/se22/html/jls-13.html#jls-13.4.2">
44 * Java Language Specification</a> for more information about sealed classes.
45 * </p>
46 *
47 * <p>
48 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
49 * </p>
50 *
51 * <p>
52 * Violation Message Keys:
53 * </p>
54 * <ul>
55 * <li>
56 * {@code sealed.should.have.permits}
57 * </li>
58 * </ul>
59 *
60 * @since 10.18.0
61 */
62
63 @StatelessCheck
64 public class SealedShouldHavePermitsListCheck extends AbstractCheck {
65
66 /**
67 * A key is pointing to the warning message text in "messages.properties"
68 * file.
69 */
70 public static final String MSG_KEY = "sealed.should.have.permits";
71
72 @Override
73 public int[] getDefaultTokens() {
74 return getRequiredTokens();
75 }
76
77 @Override
78 public int[] getAcceptableTokens() {
79 return getRequiredTokens();
80 }
81
82 @Override
83 public int[] getRequiredTokens() {
84 return new int[] {
85 TokenTypes.CLASS_DEF,
86 TokenTypes.INTERFACE_DEF,
87 };
88 }
89
90 @Override
91 public void visitToken(DetailAST ast) {
92 final DetailAST modifiers = ast.findFirstToken(TokenTypes.MODIFIERS);
93 final boolean isSealed = modifiers.findFirstToken(TokenTypes.LITERAL_SEALED) != null;
94 final boolean hasPermitsList = ast.findFirstToken(TokenTypes.PERMITS_CLAUSE) != null;
95
96 if (isSealed && !hasPermitsList) {
97 log(ast, MSG_KEY);
98 }
99 }
100 }