Class ParameterNumberCheck
java.lang.Object
com.puppycrawl.tools.checkstyle.api.AutomaticBean
com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
com.puppycrawl.tools.checkstyle.api.AbstractCheck
com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the number of parameters of a method or constructor.
-
Property
max
- Specify the maximum number of parameters allowed. Type isint
. Default value is7
. -
Property
ignoreOverriddenMethods
- Ignore number of parameters for methods with@Override
annotation. Type isboolean
. Default value isfalse
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: METHOD_DEF, CTOR_DEF.
To configure the check:
<module name="ParameterNumber"/>
To configure the check to allow 10 parameters for a method:
<module name="ParameterNumber"> <property name="max" value="10"/> <property name="tokens" value="METHOD_DEF"/> </module>
To configure the check to ignore number of parameters for methods with
@Override
or @java.lang.Override annotation
.
Rationale: developer may need to override method with many parameters from 3-rd party library. In this case developer has no control over number of parameters.
<module name="ParameterNumber"> <property name="ignoreOverriddenMethods" value="true"/> </module>
Java code example:
@Override public void needsLotsOfParameters(int a, int b, int c, int d, int e, int f, int g, int h) { ... }
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
maxParam
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final String
CanonicalOverride
annotation name.private static final int
Default maximum number of allowed parameters.private boolean
Ignore number of parameters for methods with@Override
annotation.private int
Specify the maximum number of parameters allowed.static final String
A key is pointing to the warning message text in "messages.properties" file.private static final String
Override
annotation name. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.void
setIgnoreOverriddenMethods
(boolean ignoreOverriddenMethods) Setter to ignore number of parameters for methods with@Override
annotation.void
setMax
(int max) Setter to specify the maximum number of parameters allowed.private boolean
Determine whether to ignore number of parameters for the method.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearViolations, destroy, finishTree, getFileContents, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
OVERRIDE
Override
annotation name.- See Also:
-
CANONICAL_OVERRIDE
CanonicalOverride
annotation name.- See Also:
-
DEFAULT_MAX_PARAMETERS
private static final int DEFAULT_MAX_PARAMETERSDefault maximum number of allowed parameters.- See Also:
-
max
private int maxSpecify the maximum number of parameters allowed. -
ignoreOverriddenMethods
private boolean ignoreOverriddenMethodsIgnore number of parameters for methods with@Override
annotation.
-
-
Constructor Details
-
ParameterNumberCheck
public ParameterNumberCheck()
-
-
Method Details
-
setMax
public void setMax(int max) Setter to specify the maximum number of parameters allowed.- Parameters:
max
- the max allowed parameters
-
setIgnoreOverriddenMethods
public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods) Setter to ignore number of parameters for methods with@Override
annotation.- Parameters:
ignoreOverriddenMethods
- set ignore overridden methods
-
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:
-
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:
-
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:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
shouldIgnoreNumberOfParameters
Determine whether to ignore number of parameters for the method.- Parameters:
ast
- the token to process- Returns:
- true if this is overridden method and number of parameters should be ignored false otherwise
-