Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

com.puppycrawl.tools.checkstyle.checks.whitespace

Class MethodParamPadCheck

Implemented Interfaces:
Configurable, Contextualizable
public class MethodParamPadCheck
extends AbstractOptionCheck
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>
Version:
1.0
Author:
Rick Giles

Constructor Summary

MethodParamPadCheck()
Sets the pad otion to nospace.

Method Summary

int[]
getDefaultTokens()
void
setAllowLineBreaks(boolean aAllowLineBreaks)
Control whether whitespace is flagged at linebreaks.
void
visitToken(DetailAST aAST)

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck

getAbstractOption, setOption

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getDefaultTokens, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens, visitToken

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

getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, log, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Constructor Details

MethodParamPadCheck

public MethodParamPadCheck()
Sets the pad otion to nospace.

Method Details

getDefaultTokens

public int[] getDefaultTokens()
Overrides:
getDefaultTokens in interface Check

setAllowLineBreaks

public void setAllowLineBreaks(boolean aAllowLineBreaks)
Control whether whitespace is flagged at linebreaks.
Parameters:
aAllowLineBreaks - whether whitespace should be flagged at linebreaks.

visitToken

public void visitToken(DetailAST aAST)
Overrides:
visitToken in interface Check

Overview Package Class Use Tree Index Deprecated About
Back to the Checkstyle Home Page