Class RecordComponentNumberCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.sizes.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
accessModifiers
- Access modifiers of record definitions where the number of record components should be checked. Type iscom.puppycrawl.tools.checkstyle.checks.naming.AccessModifierOption[]
. Default value ispublic, protected, package, private
. -
Property
max
- Specify the maximum number of components allowed in the header of a record definition. Type isint
. Default value is8
.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
too.many.components
- Since:
- 8.36
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private AccessModifierOption[]
accessModifiers
Access modifiers of record definitions where the number of record components should be checked.private static int
DEFAULT_MAX_COMPONENTS
Default maximum number of allowed components.private int
max
Specify the maximum number of components allowed in the header of a record definition.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
Constructor Summary
Constructors Constructor Description RecordComponentNumberCheck()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static int
countComponents(DetailAST recordComponents)
Method to count the number of record components in this record definition.int[]
getAcceptableTokens()
The configurable token set.int[]
getDefaultTokens()
Returns the default token a check is interested in.int[]
getRequiredTokens()
The tokens that this check must be registered for.private boolean
matchAccessModifiers(AccessModifierOption accessModifier)
Checks whether a record definition has the correct access modifier to be checked.void
setAccessModifiers(AccessModifierOption... accessModifiers)
Setter to access modifiers of record definitions where the number of record components should be checked.void
setMax(int value)
Setter to specify the maximum number of components allowed in the header of a record definition.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_KEY
public static final String MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
DEFAULT_MAX_COMPONENTS
private static final int DEFAULT_MAX_COMPONENTS
Default maximum number of allowed components.- See Also:
- Constant Field Values
-
max
private int max
Specify the maximum number of components allowed in the header of a record definition.
-
accessModifiers
private AccessModifierOption[] accessModifiers
Access modifiers of record definitions where the number of record components should be checked.
-
-
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.- Since:
- 8.36
-
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.- Since:
- 8.36
-
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 classAbstractCheck
- 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 classAbstractCheck
- 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 classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
TokenTypes
-
visitToken
public void visitToken(DetailAST ast)
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
countComponents
private static int countComponents(DetailAST recordComponents)
Method to count the number of record components in this record definition.- Parameters:
recordComponents
- the ast to check- Returns:
- the number of record components in this record definition
-
matchAccessModifiers
private boolean matchAccessModifiers(AccessModifierOption accessModifier)
Checks whether a record definition has the correct access modifier to be checked.- Parameters:
accessModifier
- the access modifier of the record definition.- Returns:
- whether the record definition matches the expected access modifier.
-
-