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.naming;
21
22 import com.puppycrawl.tools.checkstyle.api.DetailAST;
23 import com.puppycrawl.tools.checkstyle.api.TokenTypes;
24
25 /**
26 * <div>
27 * Checks that class type parameter names conform to a specified pattern.
28 * </div>
29 *
30 * @since 5.0
31 */
32 public class ClassTypeParameterNameCheck
33 extends AbstractNameCheck {
34
35 /**
36 * A key is pointing to the warning message text in "messages.properties"
37 * file.
38 */
39 public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
40
41 /** Creates a new {@code ClassTypeParameterNameCheck} instance. */
42 public ClassTypeParameterNameCheck() {
43 super("^[A-Z]$", MSG_INVALID_PATTERN);
44 }
45
46 @Override
47 public int[] getDefaultTokens() {
48 return getRequiredTokens();
49 }
50
51 @Override
52 public final int[] getAcceptableTokens() {
53 return getRequiredTokens();
54 }
55
56 @Override
57 public int[] getRequiredTokens() {
58 return new int[] {
59 TokenTypes.TYPE_PARAMETER,
60 };
61 }
62
63 @Override
64 protected final boolean mustCheckName(DetailAST ast) {
65 final DetailAST location =
66 ast.getParent().getParent();
67 return location.getType() == TokenTypes.CLASS_DEF;
68 }
69
70 }