Class MethodParamPadCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
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 a violation, unless configured to
allow line breaks. To allow linebreaks after the identifier, set property
allowLineBreaks
to true
.
-
Property
allowLineBreaks
- Allow a line break between the identifier and left parenthesis. Type isboolean
. Default value isfalse
. -
Property
option
- Specify policy on how to pad method parameter. Type iscom.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
. Default value isnospace
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: CTOR_DEF, LITERAL_NEW, METHOD_CALL, METHOD_DEF, SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF.
To configure the check:
<module name="MethodParamPad"/>
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:
<module name="MethodParamPad"> <property name="tokens" value="METHOD_DEF"/> <property name="option" value="space"/> <property name="allowLineBreaks" value="true"/> </module>
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
line.previous
-
ws.notPreceded
-
ws.preceded
- Since:
- 3.4
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.void
setAllowLineBreaks
(boolean allowLineBreaks) Setter to allow a line break between the identifier and left parenthesis.void
Setter to specify policy on how to pad method parameter.void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
-
Constructor Details
-
MethodParamPadCheck
public MethodParamPadCheck()
-
-
Method Details
-
getDefaultTokens
public int[] getDefaultTokens()Description copied from class:AbstractCheck
Returns the default token a check is interested in. Only used if the configuration for a check does not define the tokens.- Specified by:
getDefaultTokens
in classAbstractCheck
- Returns:
- the default tokens
- See Also:
-
getAcceptableTokens
public int[] getAcceptableTokens()Description copied from class:AbstractCheck
The configurable token set. Used to protect Checks against malicious users who specify an unacceptable token set in the configuration file. The default implementation returns the check's default tokens.- Specified by:
getAcceptableTokens
in classAbstractCheck
- Returns:
- the token set this check is designed for.
- See Also:
-
getRequiredTokens
public int[] getRequiredTokens()Description copied from class:AbstractCheck
The tokens that this check must be registered for.- Specified by:
getRequiredTokens
in classAbstractCheck
- Returns:
- the token set this must be registered for.
- See Also:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-
setAllowLineBreaks
public void setAllowLineBreaks(boolean allowLineBreaks) Setter to allow a line break between the identifier and left parenthesis.- Parameters:
allowLineBreaks
- whether whitespace should be flagged at line breaks.
-
setOption
Setter to specify policy on how to pad method parameter.- Parameters:
optionStr
- string to decode option from- Throws:
IllegalArgumentException
- if unable to decode
-