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. 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. LAMBDA.

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>
 

Nested Class Summary

Nested Classes

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

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_NEW 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 The policy to enforce.
private boolean	shouldStartLine Do we need to check if right curly starts line.

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) Checks whether right curly is alone on a line.
private static boolean	isAnonInnerClassInit(DetailAST lcurly) Checks whether lcurly is in anonymous inner class initialization.
private static boolean	isEmptyBody(DetailAST lcurly) Checks if definition body is empty.
private static boolean	isOnStartOfLine(RightCurlyCheck.Details details, java.lang.String targetSourceLine) Whether right curly brace starts target source line.
private static boolean	isSingleLineBlock(RightCurlyCheck.Details details) Checks whether block has a single-line format.
void	setOption(java.lang.String optionStr) Sets the option to enforce.
void	setShouldStartLine(boolean flag) Does the check need to check if right curly starts line.
private static boolean	shouldBeAloneOnLine(RightCurlyOption bracePolicy, RightCurlyCheck.Details details) Checks that a right curly should be alone on a line.
private static boolean	shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details details) Whether right curly should be alone on line when ALONE option is used.
private static boolean	shouldBeAloneOnLineWithAloneOrSinglelineOption(RightCurlyCheck.Details details) Whether right curly should be alone on line when ALONE_OR_SINGLELINE 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 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, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, 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

MSG_KEY_LINE_NEW

public static final java.lang.String MSG_KEY_LINE_NEW

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

See Also:

Constant Field Values

shouldStartLine

private boolean shouldStartLine

Do we need to check if right curly starts line.

option

private RightCurlyOption option

The policy to enforce.

Constructor Detail

RightCurlyCheck

public RightCurlyCheck()

Method Detail

setOption

public void setOption(java.lang.String optionStr)

Sets the option to enforce.

Parameters:

optionStr - string to decode option from

Throws:

java.lang.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 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)

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

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.

shouldBeAloneOnLineWithAloneOption

private static boolean shouldBeAloneOnLineWithAloneOption(RightCurlyCheck.Details details)

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

Parameters:

details - details for validation.

Returns:

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

shouldBeAloneOnLineWithAloneOrSinglelineOption

private static boolean shouldBeAloneOnLineWithAloneOrSinglelineOption(RightCurlyCheck.Details details)

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

Parameters:

details - details for validation.

Returns:

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

isOnStartOfLine

private static boolean isOnStartOfLine(RightCurlyCheck.Details details,
                                       java.lang.String targetSourceLine)

Whether right curly brace starts target source line.

Parameters:

details - Details of right curly brace for validation

targetSourceLine - source line to check

Returns:

true if right curly brace starts target source line.

isAloneOnLine

private static boolean isAloneOnLine(RightCurlyCheck.Details details)

Checks whether right curly is alone on a line.

Parameters:

details - for validation.

Returns:

true if right curly is alone on a line.

isSingleLineBlock

private static boolean isSingleLineBlock(RightCurlyCheck.Details details)

Checks whether block has a single-line format.

Parameters:

details - for validation.

Returns:

true if block has single-line format.

isAnonInnerClassInit

private static boolean isAnonInnerClassInit(DetailAST lcurly)

Checks whether lcurly is in anonymous inner class initialization.

Parameters:

lcurly - left curly token.

Returns:

true if lcurly begins anonymous inner class initialization.

isEmptyBody

private static boolean isEmptyBody(DetailAST lcurly)

Checks if definition body is empty.

Parameters:

lcurly - left curly.

Returns:

true if definition body is empty.

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.