public class ParenPadCheck extends Check
Checks 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, with the exception that it does
not check for padding of the right parenthesis at an empty for iterator and
empty for initializer.
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.
The policy to verify is specified using the PadOption
class and
defaults to PadOption.NOSPACE
.
By default the check will check parentheses that occur with the following
tokens:
ANNOTATION
,
ANNOTATION_FIELD_DEF
,
CTOR_DEF
,
CTOR_CALL
,
ENUM_CONSTANT_DEF
,
EXPR
,
LITERAL_CATCH
,
LITERAL_DO
,
LITERAL_FOR
,
LITERAL_IF
,
LITERAL_NEW
,
LITERAL_SWITCH
,
LITERAL_SYNCHRONIZED
,
LITERAL_WHILE
,
METHOD_CALL
,
METHOD_DEF
,
RESOURCE_SPECIFICATION
,
SUPER_CTOR_CALL
,
QUESTION
,
An example of how to configure the check is:
<module name="ParenPad"/>
An example of how to configure the check to require spaces for the parentheses of constructor, method, and super constructor invocations is:
<module name="ParenPad"> <property name="tokens" value="CTOR_CALL, METHOD_CALL, SUPER_CTOR_CALL"/> <property name="option" value="space"/> </module>
Modifier and Type | Field and Description |
---|---|
static String |
WS_FOLLOWED
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
WS_NOT_FOLLOWED
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
WS_NOT_PRECEDED
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
WS_PRECEDED
A key is pointing to the warning message text in "messages.properties"
file.
|
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.
|
protected void |
processLeft(DetailAST ast)
Process a token representing a left parentheses.
|
protected void |
processRight(DetailAST ast)
Process a token representing a right parentheses.
|
void |
setOption(String optionStr)
Set the option to enforce.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String WS_FOLLOWED
public static final String WS_NOT_FOLLOWED
public static final String WS_PRECEDED
public static final String WS_NOT_PRECEDED
public ParenPadCheck()
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public int[] getRequiredTokens()
Check
getRequiredTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processpublic void setOption(String optionStr)
optionStr
- string to decode option fromorg.apache.commons.beanutils.ConversionException
- if unable to decodeprotected void processLeft(DetailAST ast)
ast
- the token representing a left parenthesesprotected void processRight(DetailAST ast)
ast
- the token representing a right parenthesesCopyright © 2001–2016. All rights reserved.