public class MethodParamPadCheck extends AbstractOptionCheck<PadOption>
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>
Modifier and Type | Field and Description |
---|---|
static String |
LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
WS_PRECEDED
A key is pointing to the warning message text in "messages.properties"
file.
|
SEMICOLON
Constructor and Description |
---|
MethodParamPadCheck()
Sets the pad option to nospace.
|
Modifier and Type | Method and Description |
---|---|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setAllowLineBreaks(boolean allowLineBreaks)
Control whether whitespace is flagged at line breaks.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
getAbstractOption, setOption
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String LINE_PREVIOUS
public static final String WS_PRECEDED
public static final String WS_NOT_PRECEDED
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processpublic void setAllowLineBreaks(boolean allowLineBreaks)
allowLineBreaks
- whether whitespace should be
flagged at line breaks.Copyright © 2001–2015. All rights reserved.