001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2026 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.checks.naming;
021
022import com.puppycrawl.tools.checkstyle.api.DetailAST;
023import com.puppycrawl.tools.checkstyle.api.TokenTypes;
024
025/**
026 * <div>
027 * Checks that record component names conform to a specified pattern.
028 * </div>
029 *
030 * @since 8.40
031 */
032public class RecordComponentNameCheck extends AbstractNameCheck {
033
034    /**
035     * A key is pointing to the warning message text in "messages.properties"
036     * file.
037     */
038    public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
039
040    /** Creates a new {@code RecordComponentNameCheck} instance. */
041    public RecordComponentNameCheck() {
042        super("^[a-z][a-zA-Z0-9]*$", MSG_INVALID_PATTERN);
043    }
044
045    @Override
046    public int[] getDefaultTokens() {
047        return getRequiredTokens();
048    }
049
050    @Override
051    public final int[] getAcceptableTokens() {
052        return getRequiredTokens();
053    }
054
055    @Override
056    public int[] getRequiredTokens() {
057        return new int[] {
058            TokenTypes.RECORD_COMPONENT_DEF,
059        };
060    }
061
062    @Override
063    protected final boolean mustCheckName(DetailAST ast) {
064        return true;
065    }
066
067}