View Javadoc
1   ///////////////////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3   // Copyright (C) 2001-2025 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      /** Creates a new {@code RecordComponentNameCheck} instance. */
35      public RecordComponentNameCheck() {
36          super("^[a-z][a-zA-Z0-9]*$");
37      }
38  
39      @Override
40      public int[] getDefaultTokens() {
41          return getRequiredTokens();
42      }
43  
44      @Override
45      public final int[] getAcceptableTokens() {
46          return getRequiredTokens();
47      }
48  
49      @Override
50      public int[] getRequiredTokens() {
51          return new int[] {
52              TokenTypes.RECORD_COMPONENT_DEF,
53          };
54      }
55  
56      @Override
57      protected final boolean mustCheckName(DetailAST ast) {
58          return true;
59      }
60  
61  }