public class RightCurlyCheck extends AbstractOptionCheck<RightCurlyOption>
Checks the placement of right curly braces.
The policy to verify is specified using the RightCurlyOption
class
and defaults to RightCurlyOption.SAME
.
By default the check will check the following tokens:
LITERAL_TRY
,
LITERAL_CATCH
,
LITERAL_FINALLY
,
LITERAL_IF
,
LITERAL_ELSE
.
Other acceptable tokens are:
CLASS_DEF
,
METHOD_DEF
,
CTOR_DEF
.
LITERAL_FOR
.
LITERAL_WHILE
.
LITERAL_DO
.
STATIC_INIT
.
INSTANCE_INIT
.
shouldStartLine - does the check need to check if right curly starts line. Default value is true
An example of how to configure the check is:
<module name="RightCurly"/>
An example of how to configure the check with policy
RightCurlyOption.ALONE
for else
and
{@link TokenTypes#METHOD_DEF METHOD_DEF}
tokens is:
<module name="RightCurly"> <property name="tokens" value="LITERAL_ELSE"/> <property name="option" value="alone"/> </module>
Modifier and Type | Field and Description |
---|---|
static String |
MSG_KEY_LINE_ALONE
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_KEY_LINE_BREAK_BEFORE
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_KEY_LINE_NEW
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_KEY_LINE_SAME
A key is pointing to the warning message text in "messages.properties"
file.
|
SEMICOLON
Constructor and Description |
---|
RightCurlyCheck()
Sets the right curly option to same.
|
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 |
setShouldStartLine(boolean flag)
Does the check need to check if right curly starts line.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
getAbstractOption, setOption
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 MSG_KEY_LINE_BREAK_BEFORE
public static final String MSG_KEY_LINE_ALONE
public static final String MSG_KEY_LINE_SAME
public static final String MSG_KEY_LINE_NEW
public void setShouldStartLine(boolean flag)
flag
- new value of this property.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 processCopyright © 2001–2015. All rights reserved.