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 semi-colon. 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.
option - Specify policy on how to pad parentheses.
Type is com.puppycrawl.tools.checkstyle.checks.whitespace.PadOption.
Default value is nospace.
tokens - tokens to check
Type is int[].
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.
To configure the check:
<module name="ParenPad"/>
Example:
class Foo {
int n;
public void fun() { // OK
bar( 1); // violation, space after left parenthesis
}
public void bar(int k ) { // violation, space before right parenthesis
while (k > 0) { // OK
}
Test obj = new Test(k); // OK
}
public void fun2() { // OK
switch( n) { // violation, space after left parenthesis
case 2:
bar(n); // OK
default:
break;
}
}
}
To configure the check to require spaces for the parentheses of constructor, method, and super constructor calls:
<module name="ParenPad">
<property name="tokens" value="LITERAL_FOR, LITERAL_CATCH,
SUPER_CTOR_CALL"/>
<property name="option" value="space"/>
</module>
Example:
class Foo {
int x;
public Foo(int n) {
}
public void fun() {
try {
System.out.println(x);
} catch( IOException e) { // violation, no space before right parenthesis
} catch( Exception e ) { // OK
}
for ( int i = 0; i < x; i++ ) { // OK
}
}
}
class Bar extends Foo {
public Bar() {
super(1 ); // violation, no space after left parenthesis
}
public Bar(int k) {
super( k ); // OK
for ( int i = 0; i < k; i++) { // violation, no space before right parenthesis
}
}
}
The following cases are not checked:
for ( ; i < j; i++, j--) // no check after left parenthesis for (Iterator it = xs.iterator(); it.hasNext(); ) // no check before right parenthesis try (Closeable resource = acquire(); ) // no check before right parenthesis
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
ws.followed
ws.notFollowed
ws.notPreceded
ws.preceded
AutomaticBean.OutputStreamOptionsMSG_WS_FOLLOWED, MSG_WS_NOT_FOLLOWED, MSG_WS_NOT_PRECEDED, MSG_WS_PRECEDED| Constructor and Description |
|---|
ParenPadCheck()
Initializes and sorts acceptableTokens to make binary search over it possible.
|
| Modifier and Type | Method and 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 |
visitToken(DetailAST ast)
Called to process a token.
|
processLeft, processRight, setOptionbeginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setFileContents, setTabWidth, setTokensfinishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverityconfigure, contextualize, getConfiguration, setupChildpublic ParenPadCheck()
public int[] getDefaultTokens()
AbstractCheckgetDefaultTokens in class AbstractCheckTokenTypespublic int[] getAcceptableTokens()
AbstractCheckgetAcceptableTokens in class AbstractCheckTokenTypespublic int[] getRequiredTokens()
AbstractCheckgetRequiredTokens in class AbstractCheckTokenTypespublic void visitToken(DetailAST ast)
AbstractCheckvisitToken in class AbstractCheckast - the token to processCopyright © 2001–2020. All rights reserved.