Class MethodParamPadCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.api.AutomaticBean
-
- com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
-
- com.puppycrawl.tools.checkstyle.api.AbstractCheck
-
- com.puppycrawl.tools.checkstyle.checks.whitespace.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>
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowLineBreaks
Whether whitespace is allowed if the method identifier is at a linebreak.static java.lang.String
MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.static java.lang.String
MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.private PadOption
option
The policy to enforce.
-
Constructor Summary
Constructors Constructor Description MethodParamPadCheck()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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
setOption(java.lang.String optionStr)
Set the option to enforce.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_LINE_PREVIOUS
public static final java.lang.String MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_WS_PRECEDED
public static final java.lang.String MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_WS_NOT_PRECEDED
public static final java.lang.String MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
allowLineBreaks
private boolean allowLineBreaks
Whether whitespace is allowed if the method identifier is at a linebreak.
-
option
private PadOption option
The policy to enforce.
-
-
Method Detail
-
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:
TokenTypes
-
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:
TokenTypes
-
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:
TokenTypes
-
visitToken
public void visitToken(DetailAST ast)
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)
Control whether whitespace is flagged at line breaks.- Parameters:
allowLineBreaks
- whether whitespace should be flagged at line breaks.
-
setOption
public void setOption(java.lang.String optionStr)
Set the option to enforce.- Parameters:
optionStr
- string to decode option from- Throws:
java.lang.IllegalArgumentException
- if unable to decode
-
-