Class RightCurlyCheck
- All Implemented Interfaces:
Configurable
,Contextualizable
Checks the placement of right curly braces ('
'}) for code blocks. This check supports
if-else, try-catch-finally blocks, while-loops, for-loops,
method definitions, class definitions, constructor definitions,
instance, static initialization blocks, annotation definitions and enum definitions.
For right curly brace of expression blocks of arrays, lambdas and class instances
please follow issue
#5945.
For right curly brace of enum constant please follow issue
#7519.
-
Property
option
- Specify the policy on placement of a right curly brace ('}'
). Type iscom.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption
. Default value issame
. -
Property
tokens
- tokens to check Type isjava.lang.String[]
. Validation type istokenSet
. Default value is: LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE.
To configure the check:
<module name="RightCurly"/>
Example:
public class Test { public void test() { if (foo) { bar(); } // violation, right curly must be in the same line as the 'else' keyword else { bar(); } if (foo) { bar(); } else { // OK bar(); } if (foo) { bar(); } int i = 0; // violation // ^^^ statement is not allowed on same line after curly right brace if (foo) { bar(); } // OK int i = 0; try { bar(); } // violation, rightCurly must be in the same line as 'catch' keyword catch (Exception e) { bar(); } try { bar(); } catch (Exception e) { // OK bar(); } } // OK public void testSingleLine() { bar(); } // OK, because singleline is allowed }
To configure the check with policy alone
for else
and
METHOD_DEF tokens:
<module name="RightCurly"> <property name="option" value="alone"/> <property name="tokens" value="LITERAL_ELSE, METHOD_DEF"/> </module>
Example:
public class Test { public void test() { if (foo) { bar(); } else { bar(); } // violation, right curly must be alone on line if (foo) { bar(); } else { bar(); } // OK try { bar(); } catch (Exception e) { // OK because config is set to token METHOD_DEF and LITERAL_ELSE bar(); } } // OK public void violate() { bar; } // violation, singleline is not allowed here public void ok() { bar(); } // OK }
To configure the check with policy alone_or_singleline
for if
and
METHOD_DEF
tokens:
<module name="RightCurly"> <property name="option" value="alone_or_singleline"/> <property name="tokens" value="LITERAL_IF, METHOD_DEF"/> </module>
Example:
public class Test { public void test() { if (foo) { bar(); } else { // violation, right curly must be alone on line bar(); } if (foo) { bar(); } // OK else { bar(); } try { bar(); } catch (Exception e) { // OK because config did not set token LITERAL_TRY bar(); } } // OK public void violate() { bar(); } // OK , because singleline }
Parent is com.puppycrawl.tools.checkstyle.TreeWalker
Violation Message Keys:
-
line.alone
-
line.break.before
-
line.same
- Since:
- 3.0
-
Nested Class Summary
Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean
AutomaticBean.OutputStreamOptions
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file.static final String
A key is pointing to the warning message text in "messages.properties" file. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionint[]
The configurable token set.int[]
Returns the default token a check is interested in.int[]
The tokens that this check must be registered for.void
Setter to specify the policy on placement of a right curly brace ('}'
).void
visitToken
(DetailAST ast) Called to process a token.Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck
beginTree, clearMessages, destroy, finishTree, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, 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.api.AutomaticBean
configure, contextualize, getConfiguration, setupChild
-
Field Details
-
MSG_KEY_LINE_BREAK_BEFORE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_KEY_LINE_ALONE
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
MSG_KEY_LINE_SAME
A key is pointing to the warning message text in "messages.properties" file.- See Also:
-
-
Constructor Details
-
RightCurlyCheck
public RightCurlyCheck()
-
-
Method Details
-
setOption
Setter to specify the policy on placement of a right curly brace ('}'
).- Parameters:
optionStr
- string to decode option from- Throws:
IllegalArgumentException
- if unable to decode
-
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:
-
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:
-
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:
-
visitToken
Description copied from class:AbstractCheck
Called to process a token.- Overrides:
visitToken
in classAbstractCheck
- Parameters:
ast
- the token to process
-