Package com.puppycrawl.tools.checkstyle.checks.sizes

Class RecordComponentNumberCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable
    public class RecordComponentNumberCheck
extends AbstractCheck

    Checks the number of record components in the header of a record definition.

    • Property max - Specify the maximum number of components allowed in the header of a record definition. Type is int. Default value is 8.
    • Property accessModifiers - Access modifiers of record definitions where the number of record components should be checked. Type is com.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption[]. Default value is public, protected, package, private.

    To configure the check: 

     <module name="RecordComponentNumber"/>

    Java code example: 

     public record MyRecord1(int x, int y) { // ok, 2 components
     ...
 }

 record MyRecord2(int x, int y, String str,
                           Node node, Order order, Data data
                           String location, Date date, Image image) { // violation, 9 components
     ...
 }

    To configure the check to allow 5 record components at all access modifier levels for record definitions: 

     <module name="RecordComponentNumber">
   <property name="max" value="5"/>
 </module>

    Java code example: 

     public record MyRecord1(int x, int y, String str) { // ok, 3 components
     ...
 }

 public record MyRecord2(int x, int y, String str,
                           Node node, Order order, Data data) { // violation, 6 components
     ...
 }

    To configure the check to allow 10 record components for a public record definition, but 3 for private record definitions: 

     <module name="RecordComponentNumber">
   <property name="max" value="3"/>
   <property name="accessModifiers" value="private"/>
 </module>
 <module name="RecordComponentNumber">
   <property name="max" value="10"/>
   <property name="accessModifiers" value="public"/>
 </module>

    Java code example: 

     public record MyRecord1(int x, int y, String str) { // ok, public record definition allowed 10
     ...
 }

 private record MyRecord2(int x, int y, String str, Node node) { // violation
     ...                                // private record definition allowed 3 components
 }

    Parent is com.puppycrawl.tools.checkstyle.TreeWalker

    Violation Message Keys:

    • too.many.components
    Since:
    8.36

    • Field Detail

      • MSG_KEY

        public static final java.lang.String MSG_KEY
        A key is pointing to the warning message text in "messages.properties" file.
        See Also:
        Constant Field Values

    • Constructor Detail

      • RecordComponentNumberCheck

        public RecordComponentNumberCheck()

    • Method Detail

      • setMax

        public void setMax​(int value)
        Setter to specify the maximum number of components allowed in the header of a record definition.
        Parameters:
        value - the maximum allowed.

      • setAccessModifiers

        public void setAccessModifiers​(AccessModifierOption... accessModifiers)
        Setter to access modifiers of record definitions where the number of record components should be checked.
        Parameters:
        accessModifiers - access modifiers of record definitions which should be checked.

      • getDefaultTokens

        public int[] getDefaultTokens()
        Description copied from class: AbstractCheck
        Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.
        Specified by:
        getDefaultTokens in class AbstractCheck
        Returns:
        the default tokens
        See Also:
        TokenTypes

      • getAcceptableTokens

        public 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

      • getRequiredTokens

        public int[] getRequiredTokens()
        Description copied from class: AbstractCheck
        The tokens that this check must be registered for.
        Specified by:
        getRequiredTokens in class AbstractCheck
        Returns:
        the token set this must be registered for.
        See Also:
        TokenTypes