com.puppycrawl.tools.checkstyle.checks.naming.PatternVariableNameCheck Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of checkstyle Show documentation
Checkstyle is a development tool to help programmers write Java code that adheres to a coding standard
There is a newer version: 10.18.1
////////////////////////////////////////////////////////////////////////////////
// checkstyle: Checks Java source code for adherence to a set of rules.
// Copyright (C) 2001-2022 the original author or authors.
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
////////////////////////////////////////////////////////////////////////////////

package com.puppycrawl.tools.checkstyle.checks.naming;

import com.puppycrawl.tools.checkstyle.api.DetailAST;
import com.puppycrawl.tools.checkstyle.api.TokenTypes;

/**
 * 
 * Checks that pattern variable names conform to a specified pattern.
 * 
 * 
 * 
 * Property {@code format} - Specifies valid identifiers.
 * Type is {@code java.util.regex.Pattern}.
 * Default value is {@code "^[a-z][a-zA-Z0-9]*$"}.
 * 
 * 
 * 
 * To configure the check:
 * 
 *  * <module name="PatternVariableName"/>
 * 
 * Code Example:
 *  * class MyClass {
 *     MyClass(Object o1){
 *         if (o1 instanceof String STRING) { // violation, name 'STRING' must
 *                                            // match pattern '^[a-z][a-zA-Z0-9]*$'
 *         }
 *         if (o1 instanceof Integer num) { // OK
 *         }
 *     }
 * }
 * 
 * 
 * An example of how to configure the check for names that have a lower case letter, followed by
 * letters and digits, optionally separated by underscore:
 * 
 *  * <module name="PatternVariableName">
 *   <property name="format" value="^[a-z](_?[a-zA-Z0-9]+)*$"/>
 * </module>
 * 
 * Code Example:
 *  * class MyClass {
 *     MyClass(Object o1){
 *         if (o1 instanceof String STR) { // violation, name 'STR' must
 *                                         // match pattern '^[a-z](_?[a-zA-Z0-9]+)*$'
 *         }
 *         if (o1 instanceof Integer num) { // OK
 *         }
 *         if (o1 instanceof Integer num_1) { // OK
 *         }
 *     }
 * }
 * 
 * 
 * An example of how to configure the check to that all variables have 3 or more chars in name:
 * 
 *  * <module name="PatternVariableName">
 *   <property name="format" value="^[a-z][_a-zA-Z0-9]{2,}$"/>
 * </module>
 * 
 * Code Example:
 *  * class MyClass {
 *     MyClass(Object o1){
 *         if (o1 instanceof String s) { // violation, name 's' must
 *                                       // match pattern '^[a-z][_a-zA-Z0-9]{2,}$'
 *         }
 *         if (o1 instanceof Integer num) { // OK
 *         }
 *     }
 * }
 * 
 * 
 * Parent is {@code com.puppycrawl.tools.checkstyle.TreeWalker}
 * 
 * 
 * Violation Message Keys:
 * 
 * 
 * 
 * {@code name.invalidPattern}
 * 
 * 
 *
 * @since 8.36
 */
public class PatternVariableNameCheck extends AbstractNameCheck {

    /** Creates a new {@code PatternVariableNameCheck} instance. */
    public PatternVariableNameCheck() {
        super("^[a-z][a-zA-Z0-9]*$");
    }

    @Override
    public int[] getDefaultTokens() {
        return getRequiredTokens();
    }

    @Override
    public int[] getAcceptableTokens() {
        return getRequiredTokens();
    }

    @Override
    public int[] getRequiredTokens() {
        return new int[] {
            TokenTypes.PATTERN_VARIABLE_DEF,
        };
    }

    @Override
    protected final boolean mustCheckName(DetailAST ast) {
        return true;
    }
}