001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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 * <p>
027 * Checks that record type parameter names conform to a specified pattern.
028 * </p>
029 * <ul>
030 * <li>
031 * Property {@code format} - Sets the pattern to match valid identifiers.
032 * Type is {@code java.util.regex.Pattern}.
033 * Default value is {@code "^[A-Z]$"}.
034 * </li>
035 * </ul>
036 * <p>
037 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
038 * </p>
039 * <p>
040 * Violation Message Keys:
041 * </p>
042 * <ul>
043 * <li>
044 * {@code name.invalidPattern}
045 * </li>
046 * </ul>
047 *
048 * @since 8.36
049 */
050public class RecordTypeParameterNameCheck extends AbstractNameCheck {
051
052    /** Creates a new {@code RecordTypeParameterNameCheck} instance. */
053    public RecordTypeParameterNameCheck() {
054        super("^[A-Z]$");
055    }
056
057    @Override
058    public int[] getDefaultTokens() {
059        return getRequiredTokens();
060    }
061
062    @Override
063    public final int[] getAcceptableTokens() {
064        return getRequiredTokens();
065    }
066
067    @Override
068    public int[] getRequiredTokens() {
069        return new int[] {
070            TokenTypes.TYPE_PARAMETER,
071        };
072    }
073
074    @Override
075    protected final boolean mustCheckName(DetailAST ast) {
076        final DetailAST location =
077                ast.getParent().getParent();
078        return location.getType() == TokenTypes.RECORD_DEF;
079    }
080
081}