Package com.puppycrawl.tools.checkstyle.checks.naming

Class RecordComponentNameCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class RecordComponentNameCheck
extends AbstractNameCheck

    Checks that record component names conform to a specified pattern.

    • Property format - Specifies valid identifiers. Type is java.util.regex.Pattern. Default value is "^[a-z][a-zA-Z0-9]*$".

    To configure the check: 

     <module name="RecordComponentName"/>

    Example:

     record MyRecord1(String value, int otherComponentName) {} // OK
 record MyRecord2(String... Values) {} // violation, the record component name
                                     // should match the regular expression "^[a-z][a-zA-Z0-9]*$"
 record MyRecord3(double my_number) {} // violation, the record component name
                                     // should match the regular expression "^[a-z][a-zA-Z0-9]*$"

    An example of how to configure the check for names that are only letters in lowercase:

    Configuration:

     <module name="RecordComponentName">
   <property name="format" value="^[a-z]+$"/>
 </module>

    Example:

     record MyRecord1(String value, int other) {} // OK
 record MyRecord2(String... strings) {} // OK
 record MyRecord3(double myNumber) {} // violation, the record component name
                              // should match the regular expression "^[a-z]+$"

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • name.invalidPattern
    Since:
    8.40

    • Method Detail

      • getAcceptableTokens

        public final int[] getAcceptableTokens()
        Description copied from class: AbstractCheck
        The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.
        Specified by:
        getAcceptableTokens in class AbstractCheck
        Returns:
        the token set this check is designed for.
        See Also:
        TokenTypes

      • mustCheckName

        protected final boolean mustCheckName​(DetailAST ast)
        Description copied from class: AbstractNameCheck
        Decides whether the name of an AST should be checked against the format regexp.
        Specified by:
        mustCheckName in class AbstractNameCheck
        Parameters:
        ast - the AST to check.
        Returns:
        true if the IDENT subnode of ast should be checked against the format regexp.