com.puppycrawl.tools.checkstyle.checks.blocks

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 (''}) 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 is com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyOption. Default value is same.
• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. 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

Modifier and Type	Class and Description
private static class	RightCurlyCheck.Details Structure that contains all details for validation.

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.api.AutomaticBean

AutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MSG_KEY_LINE_ALONE A key is pointing to the warning message text in "messages.properties" file.
static java.lang.String	MSG_KEY_LINE_BREAK_BEFORE A key is pointing to the warning message text in "messages.properties" file.
static java.lang.String	MSG_KEY_LINE_SAME A key is pointing to the warning message text in "messages.properties" file.
private RightCurlyOption	option Specify the policy on placement of a right curly brace ('}').

Constructor Summary

Constructors

Constructor and Description
RightCurlyCheck()

Method Summary

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.
private static boolean	hasLineBreakBefore(DetailAST rightCurly) Checks if right curly has line break before.
private static boolean	isAloneOnLine(RightCurlyCheck.Details details, java.lang.String targetSrcLine) Checks whether right curly is alone on a line.
private static boolean	isBlockAloneOnSingleLine(RightCurlyCheck.Details details) Checks whether block has a single-line format and is alone on a line.
private static boolean	isRightcurlyFollowedBySemicolon(RightCurlyCheck.Details details) Checks whether the right curly is followed by a semicolon.
void	setOption(java.lang.String optionStr) Setter to specify the policy on placement of a right curly brace ('}').
private static boolean	shouldBeAloneOnLine(RightCurlyOption bracePolicy, RightCurlyCheck.Details details, java.lang.String targetSrcLine) Checks that a right curly should be alone on a line.
private static boolean	shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details details, java.lang.String targetSrcLine) Whether right curly should be alone on line when ALONE option is used.
private static boolean	shouldBeAloneOnLineWithNotAloneOption(RightCurlyCheck.Details details, java.lang.String targetSrcLine) Whether right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.
private static boolean	shouldBeOnSameLine(RightCurlyOption bracePolicy, RightCurlyCheck.Details details) Checks that a right curly should be on the same line as the next statement.
private static boolean	shouldHaveLineBreakBefore(RightCurlyOption bracePolicy, RightCurlyCheck.Details details) Checks whether a right curly should have a line break before.
private static boolean	skipDoubleBraceInstInit(RightCurlyCheck.Details details) This method determines if the double brace initialization should be skipped over by the check.
private java.lang.String	validate(RightCurlyCheck.Details details) Does general validation.
void	visitToken(DetailAST ast) Called to process a token.

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

beginTree, clearViolations, destroy, finishTree, getFileContents, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MSG_KEY_LINE_BREAK_BEFORE

public static final java.lang.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 java.lang.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 java.lang.String MSG_KEY_LINE_SAME

A key is pointing to the warning message text in "messages.properties" file.

See Also:

Constant Field Values

option

private RightCurlyOption option

Specify the policy on placement of a right curly brace ('}').

Constructor Detail

RightCurlyCheck

public RightCurlyCheck()

Method Detail

setOption

public void setOption(java.lang.String optionStr)

Setter to specify the policy on placement of a right curly brace ('}').

Parameters:

optionStr - string to decode option from

Throws:

java.lang.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 class AbstractCheck

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 class AbstractCheck

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 class AbstractCheck

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 class AbstractCheck

Parameters:

ast - the token to process

validate

private java.lang.String validate(RightCurlyCheck.Details details)

Does general validation.

Parameters:

details - for validation.

Returns:

violation message or empty string if there was not violation during validation.

shouldHaveLineBreakBefore

private static boolean shouldHaveLineBreakBefore(RightCurlyOption bracePolicy,
                                                 RightCurlyCheck.Details details)

Checks whether a right curly should have a line break before.

Parameters:

bracePolicy - option for placing the right curly brace.

details - details for validation.

Returns:

true if a right curly should have a line break before.

shouldBeOnSameLine

private static boolean shouldBeOnSameLine(RightCurlyOption bracePolicy,
                                          RightCurlyCheck.Details details)

Checks that a right curly should be on the same line as the next statement.

Parameters:

bracePolicy - option for placing the right curly brace

details - Details for validation

Returns:

true if a right curly should be alone on a line.

shouldBeAloneOnLine

private static boolean shouldBeAloneOnLine(RightCurlyOption bracePolicy,
                                           RightCurlyCheck.Details details,
                                           java.lang.String targetSrcLine)

Checks that a right curly should be alone on a line.

Parameters:

bracePolicy - option for placing the right curly brace

details - Details for validation

targetSrcLine - A string with contents of rcurly's line

Returns:

true if a right curly should be alone on a line.

shouldBeAloneOnLineWithAloneOption

private static boolean shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details details,
                                                          java.lang.String targetSrcLine)

Whether right curly should be alone on line when ALONE option is used.

Parameters:

details - details for validation.

targetSrcLine - A string with contents of rcurly's line

Returns:

true, if right curly should be alone on line when ALONE option is used.

shouldBeAloneOnLineWithNotAloneOption

private static boolean shouldBeAloneOnLineWithNotAloneOption(RightCurlyCheck.Details details,
                                                             java.lang.String targetSrcLine)

Whether right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.

Parameters:

details - details for validation.

targetSrcLine - A string with contents of rcurly's line

Returns:

true, if right curly should be alone on line when ALONE_OR_SINGLELINE or SAME option is used.

isAloneOnLine

private static boolean isAloneOnLine(RightCurlyCheck.Details details,
                                     java.lang.String targetSrcLine)

Checks whether right curly is alone on a line.

Parameters:

details - for validation.

targetSrcLine - A string with contents of rcurly's line

Returns:

true if right curly is alone on a line.

skipDoubleBraceInstInit

private static boolean skipDoubleBraceInstInit(RightCurlyCheck.Details details)

This method determines if the double brace initialization should be skipped over by the check. Double brace initializations are treated differently. The corresponding inner rcurly is treated as if it was alone on line even when it may be followed by another rcurly and a semi, raising no violations. Please do note though that the line should not contain anything other than the following right curly and the semi following it or else violations will be raised. Only the kind of double brace initializations shown in the following example code will be skipped over:

      Map<String, String> map = new LinkedHashMap<>() {{
           put("alpha", "man");
       }}; // no violation
 

Parameters:

details - RightCurlyCheck.Details object containing the details relevant to the rcurly

Returns:

if the double brace initialization rcurly should be skipped over by the check

isBlockAloneOnSingleLine

private static boolean isBlockAloneOnSingleLine(RightCurlyCheck.Details details)

Checks whether block has a single-line format and is alone on a line.

Parameters:

details - for validation.

Returns:

true if block has single-line format and is alone on a line.

isRightcurlyFollowedBySemicolon

private static boolean isRightcurlyFollowedBySemicolon(RightCurlyCheck.Details details)

Checks whether the right curly is followed by a semicolon.

Parameters:

details - details for validation.

Returns:

true if the right curly is followed by a semicolon.

hasLineBreakBefore

private static boolean hasLineBreakBefore(DetailAST rightCurly)

Checks if right curly has line break before.

Parameters:

rightCurly - right curly token.

Returns:

true, if right curly has line break before.