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