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 pattern variable names conform to a specified pattern.
28 * </div>
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][a-zA-Z0-9]*|_)$"}.
34 * </li>
35 * </ul>
36 *
37 * <p>
38 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
39 * </p>
40 *
41 * <p>
42 * Violation Message Keys:
43 * </p>
44 * <ul>
45 * <li>
46 * {@code name.invalidPattern}
47 * </li>
48 * </ul>
49 *
50 * @since 8.36
51 */
52 public class PatternVariableNameCheck extends AbstractNameCheck {
53
54 /** Creates a new {@code PatternVariableNameCheck} instance. */
55 public PatternVariableNameCheck() {
56 super("^([a-z][a-zA-Z0-9]*|_)$");
57 }
58
59 @Override
60 public int[] getDefaultTokens() {
61 return getRequiredTokens();
62 }
63
64 @Override
65 public int[] getAcceptableTokens() {
66 return getRequiredTokens();
67 }
68
69 @Override
70 public int[] getRequiredTokens() {
71 return new int[] {
72 TokenTypes.PATTERN_VARIABLE_DEF,
73 };
74 }
75
76 @Override
77 protected final boolean mustCheckName(DetailAST ast) {
78 return true;
79 }
80 }