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
public class ParameterNumberCheck extends AbstractCheck
Checks the number of parameters that a method or constructor has. The default allowable number of parameters is 7. To change the number of allowable parameters, set property max. Allows to ignore number of parameters for methods with @
Override
annotation.An example of how to configure the check is:
<module name="ParameterNumber"/>
An example of how to configure the check to allow 10 parameters and ignoring parameters for methods with @
Override
annotation is:<module name="ParameterNumber"> <property name="max" value="10"/> <property name="ignoreOverriddenMethods" value="true"/> </module>
Java code that will be ignored:@Override public void needsLotsOfParameters(int a, int b, int c, int d, int e, int f, int g, int h) { ... }
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
CANONICAL_OVERRIDE
CanonicalOverride
annotation name.private static int
DEFAULT_MAX_PARAMETERS
Default maximum number of allowed parameters.private boolean
ignoreOverriddenMethods
Ignore overridden methods.private int
max
The maximum number of allowed parameters.static java.lang.String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.private static java.lang.String
OVERRIDE
Override
annotation name.
-
Constructor Summary
Constructors Constructor Description ParameterNumberCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.void
setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods)
Ignore number of parameters for methods with @Override
annotation.void
setMax(int max)
Sets the maximum number of allowed parameters.private boolean
shouldIgnoreNumberOfParameters(DetailAST ast)
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, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
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
-
OVERRIDE
private static final java.lang.String OVERRIDE
Override
annotation name.- See Also:
- Constant Field Values
-
CANONICAL_OVERRIDE
private static final java.lang.String CANONICAL_OVERRIDE
CanonicalOverride
annotation name.- See Also:
- Constant Field Values
-
DEFAULT_MAX_PARAMETERS
private static final int DEFAULT_MAX_PARAMETERS
Default maximum number of allowed parameters.- See Also:
- Constant Field Values
-
max
private int max
The maximum number of allowed parameters.
-
ignoreOverriddenMethods
private boolean ignoreOverriddenMethods
Ignore overridden methods.
-
-
Method Detail
-
setMax
public void setMax(int max)
Sets the maximum number of allowed parameters.- Parameters:
max
- the max allowed parameters
-
setIgnoreOverriddenMethods
public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods)
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:
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
-
shouldIgnoreNumberOfParameters
private boolean shouldIgnoreNumberOfParameters(DetailAST ast)
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
-
-