com.puppycrawl.tools.checkstyle.checks.blocks

Class NeedBracesCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class NeedBracesCheck
extends Check

Checks for braces around code blocks.

By default the check will check the following blocks: LITERAL_DO, LITERAL_ELSE, LITERAL_FOR, LITERAL_IF, LITERAL_WHILE.

An example of how to configure the check is:

 <module name="NeedBraces"/>
 

An example of how to configure the check for if and else blocks is:

 <module name="NeedBraces">
     <property name="tokens" value="LITERAL_IF, LITERAL_ELSE"/>
 </module>
 

Check has an option allowSingleLineIf which allows one line if-statements without braces, e.g.:

if (obj.isValid()) return true;

Version:

1.0

Author:

Rick Giles, Aleksey Nesterenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	MSG_KEY_NEED_BRACES A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
NeedBracesCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultTokens() Returns the default token a check is interested in.
void	setAllowSingleLineIf(boolean allowSingleLineIf) Setter.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, 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_NEED_BRACES

public static final String MSG_KEY_NEED_BRACES

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

See Also:

Constant Field Values

Constructor Detail

NeedBracesCheck

public NeedBracesCheck()

Method Detail

setAllowSingleLineIf

public void setAllowSingleLineIf(boolean allowSingleLineIf)

Setter.

Parameters:

allowSingleLineIf - Check's option for skipping single-line if-statements

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

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