Description

Checks the number of parameters of a method or constructor.

Properties

Examples

To configure the check:

<module name="Checker">
  <module name="TreeWalker">
    <module name="ParameterNumber"/>
  </module>
</module>
        

To configure the check to allow 10 parameters for a method:

<module name="Checker">
  <module name="TreeWalker">
    <module name="ParameterNumber">
      <property name="max" value="10"/>
      <property name="tokens" value="METHOD_DEF"/>
    </module>
  </module>
</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="Checker">
  <module name="TreeWalker">
    <module name="ParameterNumber">
      <property name="ignoreOverriddenMethods" value="true"/>
    </module>
  </module>
</module>
        

Java code example:

@Override
public void needsLotsOfParameters(int a,
    int b, int c, int d, int e, int f, int g, int h) {
    ...
}
        

Example of Usage

• Sun Style
• Checkstyle Style

Violation Messages

• maxParam

All messages can be customized if the default message doesn't suit you. Please see the documentation to learn how to.

Package

com.puppycrawl.tools.checkstyle.checks.sizes

Parent Module

TreeWalker