Class ParameterNumberCheck
- 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.ParameterNumberCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ParameterNumberCheck extends AbstractCheck
Checks the number of parameters of a method or constructor.-
Property
ignoreAnnotatedBy
- Ignore methods and constructors annotated with the specified annotation(s). Type isjava.lang.String[]
. Default value is""
. -
Property
ignoreOverriddenMethods
- Ignore number of parameters for methods with@Override
annotation. Type isboolean
. Default value isfalse
. -
Property
max
- Specify the maximum number of parameters allowed. Type isint
. Default value is7
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: METHOD_DEF, CTOR_DEF.
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.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private static int
DEFAULT_MAX_PARAMETERS
Default maximum number of allowed parameters.private Set<String>
ignoreAnnotatedBy
Ignore methods and constructors annotated with the specified annotation(s).private boolean
ignoreOverriddenMethods
Ignore number of parameters for methods with@Override
annotation.private int
max
Specify the maximum number of parameters allowed.static String
MSG_KEY
A key is pointing to the warning message text in "messages.properties" file.
-
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.private boolean
isAnnotatedByIgnoredAnnotations(DetailAST ast)
Checks if method or constructor is annotated by ignored annotation(s).private boolean
isIgnoredOverriddenMethod(DetailAST ast)
Checks if method is overridden and should be ignored.void
setIgnoreAnnotatedBy(String... annotationNames)
Setter to ignore methods and constructors annotated with the specified annotation(s).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
shouldIgnoreNumberOfParameters(DetailAST ast)
Determine whether to ignore number of parameters.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_PARAMETERS
private static final int DEFAULT_MAX_PARAMETERS
Default maximum number of allowed parameters.- See Also:
- Constant Field Values
-
max
private int max
Specify the maximum number of parameters allowed.
-
ignoreOverriddenMethods
private boolean ignoreOverriddenMethods
Ignore number of parameters for methods with@Override
annotation.
-
ignoreAnnotatedBy
private Set<String> ignoreAnnotatedBy
Ignore methods and constructors annotated with the specified annotation(s).
-
-
Constructor Detail
-
ParameterNumberCheck
public ParameterNumberCheck()
-
-
Method Detail
-
setMax
public void setMax(int max)
Setter to specify the maximum number of parameters allowed.- Parameters:
max
- the max allowed parameters- Since:
- 3.0
-
setIgnoreOverriddenMethods
public void setIgnoreOverriddenMethods(boolean ignoreOverriddenMethods)
Setter to ignore number of parameters for methods with@Override
annotation.- Parameters:
ignoreOverriddenMethods
- set ignore overridden methods- Since:
- 6.2
-
setIgnoreAnnotatedBy
public void setIgnoreAnnotatedBy(String... annotationNames)
Setter to ignore methods and constructors annotated with the specified annotation(s).- Parameters:
annotationNames
- specified annotation(s)- Since:
- 10.15.0
-
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.- Parameters:
ast
- the token to process- Returns:
- true if number of parameters should be ignored.
-
isIgnoredOverriddenMethod
private boolean isIgnoredOverriddenMethod(DetailAST ast)
Checks if method is overridden and should be ignored.- Parameters:
ast
- method definition to check- Returns:
- true if method is overridden and should be ignored.
-
isAnnotatedByIgnoredAnnotations
private boolean isAnnotatedByIgnoredAnnotations(DetailAST ast)
Checks if method or constructor is annotated by ignored annotation(s).- Parameters:
ast
- method or constructor definition to check- Returns:
- true if annotated by ignored annotation(s).
-
-