com.puppycrawl.tools.checkstyle.checks.sizes

Class ParameterNumberCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.sizes.ParameterNumberCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class ParameterNumberCheck
extends Check

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) {
      ...
  }
 
 

Version:

1.0

Author:

Oliver Burn

Constructor Summary

Constructors

Constructor and Description
ParameterNumberCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setIgnoreOverriddenMethods(boolean aIgnoreOverriddenMethods) Ignore number of parameters for methods with @Override annotation.
void	setMax(int aMax) Sets the maximum number of allowed parameters.
void	visitToken(DetailAST aAST) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.Check

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterNumberCheck

public ParameterNumberCheck()

Method Detail

setMax

public void setMax(int aMax)

Sets the maximum number of allowed parameters.

Parameters:

aMax - the max allowed parameters

setIgnoreOverriddenMethods

public void setIgnoreOverriddenMethods(boolean aIgnoreOverriddenMethods)

Ignore number of parameters for methods with @Override annotation.

Parameters:

aIgnoreOverriddenMethods - set ignore overridden methods

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST aAST)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

aAST - the token to process