Class MethodParamPadCheck
- java.lang.Object
-
- com.puppycrawl.tools.checkstyle.AbstractAutomaticBean
-
- 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, constructor invocation, record, or record pattern; 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 propertyallowLineBreaks
totrue
.-
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, CTOR_CALL, LITERAL_NEW, METHOD_CALL, METHOD_DEF, SUPER_CTOR_CALL, ENUM_CONSTANT_DEF, RECORD_DEF, RECORD_PATTERN_DEF.
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.AbstractAutomaticBean
AbstractAutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field Description private boolean
allowLineBreaks
Allow a line break between the identifier and left parenthesis.static String
MSG_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.static String
MSG_WS_PRECEDED
A key is pointing to the warning message text in "messages.properties" file.private PadOption
option
Specify policy on how to pad method parameter.
-
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)
Setter to allow a line break between the identifier and left parenthesis.void
setOption(String optionStr)
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, clearViolations, destroy, finishTree, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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.AbstractAutomaticBean
configure, contextualize, getConfiguration, setupChild
-
-
-
-
Field Detail
-
MSG_LINE_PREVIOUS
public static final 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 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 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
Allow a line break between the identifier and left parenthesis.
-
-
Constructor Detail
-
MethodParamPadCheck
public MethodParamPadCheck()
-
-
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)
Setter to allow a line break between the identifier and left parenthesis.- Parameters:
allowLineBreaks
- whether whitespace should be flagged at line breaks.- Since:
- 3.4
-
setOption
public void setOption(String optionStr)
Setter to specify policy on how to pad method parameter.- Parameters:
optionStr
- string to decode option from- Throws:
IllegalArgumentException
- if unable to decode- Since:
- 3.4
-
-