com.puppycrawl.tools.checkstyle.checks.blocks

Class EmptyBlockCheck

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.AbstractOptionCheck<BlockOption>

com.puppycrawl.tools.checkstyle.checks.blocks.EmptyBlockCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class EmptyBlockCheck
extends AbstractOptionCheck<BlockOption>

Checks for empty blocks. The policy to verify is specified using the BlockOption class and defaults to BlockOption.STMT.

By default the check will check the following blocks: LITERAL_WHILE, LITERAL_TRY, LITERAL_CATCH, LITERAL_FINALLY, LITERAL_DO, LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, STATIC_INIT, LITERAL_SWITCH.

An example of how to configure the check is:

 <module name="EmptyBlock"/>
 

An example of how to configure the check for the BlockOption.TEXT policy and only catch blocks is:

 <module name="EmptyBlock">
    <property name="tokens" value="LITERAL_CATCH"/>
    <property name="option" value="text"/>
 </module>
 

Author:

Lars Kühne

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EmptyBlockCheck() Creates a new EmptyBlockCheck instance.

Method Summary

Methods

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

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.AbstractOptionCheck

getAbstractOption, setOption

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_BLOCK_NO_STMT

public static final String MSG_KEY_BLOCK_NO_STMT

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

See Also:

Constant Field Values

MSG_KEY_BLOCK_EMPTY

public static final String MSG_KEY_BLOCK_EMPTY

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

See Also:

Constant Field Values

Constructor Detail

EmptyBlockCheck

public EmptyBlockCheck()

Creates a new EmptyBlockCheck instance.

Method Detail

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

hasText

protected boolean hasText(DetailAST slistAST)

Parameters:

slistAST - a DetailAST value

Returns:

whether the SLIST token contains any text.