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>
Constructor and Description |
---|
MethodParamPadCheck()
Sets the pad otion to nospace.
|
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setAllowLineBreaks(boolean aAllowLineBreaks)
Control whether whitespace is flagged at linebreaks.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
getAbstractOption, setOption
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to processpublic void setAllowLineBreaks(boolean aAllowLineBreaks)
aAllowLineBreaks
- whether whitespace should be
flagged at linebreaks.