Class RightCurlyCheck
- 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.blocks.RightCurlyCheck
-
- All Implemented Interfaces:
Configurable
,Contextualizable
public class RightCurlyCheck extends AbstractCheck
Checks the placement of right curly braces. The policy to verify is specified using the
RightCurlyOption
class and defaults toRightCurlyOption.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
forelse
and{@link TokenTypes#METHOD_DEF METHOD_DEF}
tokens is:<module name="RightCurly"> <property name="tokens" value="LITERAL_ELSE"/> <property name="option" value="alone"/> </module>
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
-
Field Summary
Fields Modifier and Type Field 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.
-
Constructor Summary
Constructors Constructor Description RightCurlyCheck()
-
Method Summary
All 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.void
setOption(String optionStr)
Sets the option to enforce.void
setShouldStartLine(boolean flag)
Does the check need to check if right curly starts line.void
visitToken(DetailAST ast)
Called to process a token.-
Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, 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
-
-
-
-
Field Detail
-
MSG_KEY_LINE_BREAK_BEFORE
public static final String MSG_KEY_LINE_BREAK_BEFORE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_KEY_LINE_ALONE
public static final String MSG_KEY_LINE_ALONE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_KEY_LINE_SAME
public static final String MSG_KEY_LINE_SAME
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
MSG_KEY_LINE_NEW
public static final String MSG_KEY_LINE_NEW
A key is pointing to the warning message text in "messages.properties" file.- See Also:
- Constant Field Values
-
-
Method Detail
-
setOption
public void setOption(String optionStr)
Sets the option to enforce.- Parameters:
optionStr
- string to decode option from- Throws:
IllegalArgumentException
- if unable to decode
-
setShouldStartLine
public void setShouldStartLine(boolean flag)
Does the check need to check if right curly starts line.- Parameters:
flag
- new value of this property.
-
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
-
-