Class TypecastParenPadCheck
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.AbstractParenPadCheck
com.puppycrawl.tools.checkstyle.checks.whitespace.TypecastParenPadCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the policy on the padding of parentheses for typecasts. That is, whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.
-
Property
option
- Specify policy on how to pad parentheses. Type iscom.puppycrawl.tools.checkstyle.checks.whitespace.PadOption
. Default value isnospace
.
To configure the check:
<module name="TypecastParenPad"/>
Example:
class Foo { float f1 = 3.14f; int n = ( int ) f1; // violation, space after left parenthesis and before right parenthesis double d = 1.234567; float f2 = (float ) d; // violation, space before right parenthesis float f3 = (float) d; // OK float f4 = ( float) d; // violation, space after left parenthesis }
To configure the check to require spaces:
<module name="TypecastParenPad"> <property name="option" value="space"/> </module>
Example:
class Bar { double d1 = 3.14; int n = ( int ) d1; // OK int m = (int ) d1; // violation, no space after left parenthesis double d2 = 9.8; int x = (int) d2; // violation, no space after left parenthesis and before right parenthesis int y = ( int) d2; // violation, no space before right parenthesis }
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
ws.followed
-
ws.notFollowed
-
ws.notPreceded
-
ws.preceded
- Since:
- 3.2
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
Fields inherited from class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
MSG_WS_FOLLOWED, MSG_WS_NOT_FOLLOWED, MSG_WS_NOT_PRECEDED, MSG_WS_PRECEDED
-
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
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.checks.whitespace.AbstractParenPadCheck
processLeft, processRight, setOption
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
-
Constructor Details
-
TypecastParenPadCheck
public TypecastParenPadCheck()
-
-
Method Details
-
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:
-
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:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-