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.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 interface type parameter names conform to a specified pattern.
28 * </div>
29 *
30 * <ul>
31 * <li>
32 * Property {@code format} - Sets the pattern to match valid identifiers.
33 * Type is {@code java.util.regex.Pattern}.
34 * Default value is {@code "^[A-Z]$"}.
35 * </li>
36 * </ul>
37 *
38 * <p>
39 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
40 * </p>
41 *
42 * <p>
43 * Violation Message Keys:
44 * </p>
45 * <ul>
46 * <li>
47 * {@code name.invalidPattern}
48 * </li>
49 * </ul>
50 *
51 * @since 5.8
52 */
53 public class InterfaceTypeParameterNameCheck
54 extends AbstractNameCheck {
55
56 /** Creates a new {@code InterfaceTypeParameterNameCheck} instance. */
57 public InterfaceTypeParameterNameCheck() {
58 super("^[A-Z]$");
59 }
60
61 @Override
62 public int[] getDefaultTokens() {
63 return getRequiredTokens();
64 }
65
66 @Override
67 public int[] getAcceptableTokens() {
68 return getRequiredTokens();
69 }
70
71 @Override
72 public int[] getRequiredTokens() {
73 return new int[] {
74 TokenTypes.TYPE_PARAMETER,
75 };
76 }
77
78 @Override
79 protected final boolean mustCheckName(DetailAST ast) {
80 final DetailAST location =
81 ast.getParent().getParent();
82 return location.getType() == TokenTypes.INTERFACE_DEF;
83 }
84
85 }