Class ParenPadCheck
- 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.AbstractParenPadCheck
-
- com.puppycrawl.tools.checkstyle.checks.whitespace.ParenPadCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class ParenPadCheck extends AbstractParenPadCheck
Checks the policy on the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden. No check occurs at the right parenthesis after an empty for iterator, at the left parenthesis before an empty for initialization, or at the right parenthesis of a try-with-resources resource specification where the last resource variable has a trailing semicolon. Use Check EmptyForIteratorPad to validate empty for iterators and EmptyForInitializerPad to validate empty for initializers. Typecasts are also not checked, as there is TypecastParenPad to validate them.-
Property
option
- Specify policy on how to pad parentheses. 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: ANNOTATION, ANNOTATION_FIELD_DEF, CTOR_CALL, CTOR_DEF, DOT, ENUM_CONSTANT_DEF, EXPR, LITERAL_CATCH, LITERAL_DO, LITERAL_FOR, LITERAL_IF, LITERAL_NEW, LITERAL_SWITCH, LITERAL_SYNCHRONIZED, LITERAL_WHILE, METHOD_CALL, METHOD_DEF, QUESTION, RESOURCE_SPECIFICATION, SUPER_CTOR_CALL, LAMBDA, RECORD_DEF, RECORD_PATTERN_DEF.
Parent is
com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
ws.followed
-
ws.notFollowed
-
ws.notPreceded
-
ws.preceded
- Since:
- 3.0
-
-
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 BitSet
acceptableTokens
Tokens that this check handles.-
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 Constructor Description ParenPadCheck()
Initializes acceptableTokens.
-
Method Summary
All Methods Static 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.private static boolean
hasPrecedingSemiColon(DetailAST ast)
Checks that a token is preceded by a semicolon.private boolean
isAcceptableToken(DetailAST ast)
Checks whether AcceptableTokens contains the given ast.private static boolean
isFollowsEmptyForIterator(DetailAST ast)
Checks that a token follows an empty for iterator.private static boolean
isInTypecast(DetailAST ast)
Checks whetherTokenTypes.RPAREN
is a closing paren of aTokenTypes.TYPECAST
.private static boolean
isPrecedingEmptyForInit(DetailAST ast)
Checks that a token precedes an empty for initializer.private static int[]
makeAcceptableTokens()
Returns array of acceptable tokens.private void
processExpression(DetailAST ast)
private void
visitLiteralFor(DetailAST ast)
Checks parens inTokenTypes.LITERAL_FOR
.private void
visitResourceSpecification(DetailAST ast)
Checks parens inTokenTypes.RESOURCE_SPECIFICATION
.void
visitToken(DetailAST ast)
Called to process a token.private void
visitTokenWithOptionalParentheses(DetailAST ast)
Checks parens in token which may not contain parens, e.g.-
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, 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
-
acceptableTokens
private final BitSet acceptableTokens
Tokens that this check handles.
-
-
Constructor Detail
-
ParenPadCheck
public ParenPadCheck()
Initializes acceptableTokens.
-
-
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
-
visitTokenWithOptionalParentheses
private void visitTokenWithOptionalParentheses(DetailAST ast)
Checks parens in token which may not contain parens, e.g.TokenTypes.ENUM_CONSTANT_DEF
,TokenTypes.ANNOTATION
TokenTypes.LITERAL_SYNCHRONIZED
,TokenTypes.LITERAL_NEW
andTokenTypes.LAMBDA
.- Parameters:
ast
- the token to check.
-
visitResourceSpecification
private void visitResourceSpecification(DetailAST ast)
Checks parens inTokenTypes.RESOURCE_SPECIFICATION
.- Parameters:
ast
- the token to check.
-
hasPrecedingSemiColon
private static boolean hasPrecedingSemiColon(DetailAST ast)
Checks that a token is preceded by a semicolon.- Parameters:
ast
- the token to check- Returns:
- whether a token is preceded by a semicolon
-
visitLiteralFor
private void visitLiteralFor(DetailAST ast)
Checks parens inTokenTypes.LITERAL_FOR
.- Parameters:
ast
- the token to check.
-
processExpression
private void processExpression(DetailAST ast)
- Parameters:
ast
- the token to check.
-
isAcceptableToken
private boolean isAcceptableToken(DetailAST ast)
Checks whether AcceptableTokens contains the given ast.- Parameters:
ast
- the token to check.- Returns:
- true if the ast is in AcceptableTokens.
-
makeAcceptableTokens
private static int[] makeAcceptableTokens()
Returns array of acceptable tokens.- Returns:
- acceptableTokens.
-
isInTypecast
private static boolean isInTypecast(DetailAST ast)
Checks whetherTokenTypes.RPAREN
is a closing paren of aTokenTypes.TYPECAST
.- Parameters:
ast
- of aTokenTypes.RPAREN
to check.- Returns:
- true if ast is a closing paren of a
TokenTypes.TYPECAST
.
-
isFollowsEmptyForIterator
private static boolean isFollowsEmptyForIterator(DetailAST ast)
Checks that a token follows an empty for iterator.- Parameters:
ast
- the token to check- Returns:
- whether a token follows an empty for iterator
-
isPrecedingEmptyForInit
private static boolean isPrecedingEmptyForInit(DetailAST ast)
Checks that a token precedes an empty for initializer.- Parameters:
ast
- the token to check- Returns:
- whether a token precedes an empty for initializer
-
-