Class MethodParamPadCheck

  • All Implemented Interfaces:
    Configurable, Contextualizable

    public class MethodParamPadCheck
    extends AbstractCheck

    Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation; and the left parenthesis of the parameter list. That is, if the identifier and left parenthesis are on the same line, checks whether a space is required immediately after the identifier or such a space is forbidden. If they are not on the same line, reports an error, unless configured to allow line breaks.

    By default the check will check the following tokens: CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF, SUPER_CTOR_CALL.

    An example of how to configure the check is:

     <module name="MethodParamPad"/>
     

    An example of how to configure the check to require a space after the identifier of a method definition, except if the left parenthesis occurs on a new line, is:

     <module name="MethodParamPad">
         <property name="tokens" value="METHOD_DEF"/>
         <property name="option" value="space"/>
         <property name="allowLineBreaks" value="true"/>
     </module>
     
    Author:
    Rick Giles