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 java.util.Objects;
023
024import com.puppycrawl.tools.checkstyle.api.DetailAST;
025import com.puppycrawl.tools.checkstyle.api.TokenTypes;
026import com.puppycrawl.tools.checkstyle.utils.TokenUtil;
027
028/**
029 * <div>
030 * Checks lambda parameter names.
031 * </div>
032 *
033 * @since 8.11
034 */
035public class LambdaParameterNameCheck extends AbstractNameCheck {
036
037    /**
038     * A key is pointing to the warning message text in "messages.properties" file.
039     */
040    public static final String MSG_INVALID_PATTERN = "name.invalidPattern";
041
042    /** Creates new instance of {@code LambdaParameterNameCheck}. */
043    public LambdaParameterNameCheck() {
044        super("^([a-z][a-zA-Z0-9]*|_)$", MSG_INVALID_PATTERN);
045    }
046
047    @Override
048    public int[] getDefaultTokens() {
049        return getRequiredTokens();
050    }
051
052    @Override
053    public int[] getAcceptableTokens() {
054        return getRequiredTokens();
055    }
056
057    @Override
058    public int[] getRequiredTokens() {
059        return new int[] {
060            TokenTypes.LAMBDA,
061        };
062    }
063
064    @Override
065    public void visitToken(DetailAST ast) {
066        if (Objects.nonNull(ast.findFirstToken(TokenTypes.PARAMETERS))) {
067            final DetailAST parametersNode = ast.findFirstToken(TokenTypes.PARAMETERS);
068            TokenUtil.forEachChild(parametersNode, TokenTypes.PARAMETER_DEF, super::visitToken);
069        }
070        else if (!isSwitchRuleLambda(ast)) {
071            super.visitToken(ast);
072        }
073    }
074
075    @Override
076    protected boolean mustCheckName(DetailAST ast) {
077        return true;
078    }
079
080    /**
081     * Checks whether a lambda token represents a switch rule arrow.
082     * Switch rule arrows have no children, while lambda expressions do.
083     *
084     * @param lambda the lambda AST node
085     * @return true if the token represents a switch rule arrow
086     */
087    private static boolean isSwitchRuleLambda(DetailAST lambda) {
088        return !lambda.hasChildren();
089    }
090
091}