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 record component names conform to a specified pattern.
28 * </div>
29 *
30 * @since 8.40
31 */
32 public class RecordComponentNameCheck extends AbstractNameCheck {
33
34 /**
35 * A key is pointing to the warning message text in "messages.properties"
36 * file.
37 */
38 public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
39
40 /** Creates a new {@code RecordComponentNameCheck} instance. */
41 public RecordComponentNameCheck() {
42 super("^[a-z][a-zA-Z0-9]*$", MSG_INVALID_PATTERN);
43 }
44
45 @Override
46 public int[] getDefaultTokens() {
47 return getRequiredTokens();
48 }
49
50 @Override
51 public final int[] getAcceptableTokens() {
52 return getRequiredTokens();
53 }
54
55 @Override
56 public int[] getRequiredTokens() {
57 return new int[] {
58 TokenTypes.RECORD_COMPONENT_DEF,
59 };
60 }
61
62 @Override
63 protected final boolean mustCheckName(DetailAST ast) {
64 return true;
65 }
66
67 }