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

com.puppycrawl.tools.checkstyle.checks.blocks.RightCurlyCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class RightCurlyCheck
extends Check

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>
 

Author:

Oliver Burn, lkuehne, o_sukhodolsky, maxvetrenko, Andrei Selkin, liscju

Field Summary

Fields

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.

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.
void	setOption(String optionStr) Set 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.Check

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

Constructor Detail

RightCurlyCheck

public RightCurlyCheck()

Method Detail

setOption

public void setOption(String optionStr)

Set the option to enforce.

Parameters:

optionStr - string to decode option from

Throws:

org.apache.commons.beanutils.ConversionException - 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: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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.

Overrides:

getAcceptableTokens in class Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: Check

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class Check

Returns:

the token set this must be registered for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process