Package com.puppycrawl.tools.checkstyle.checks.coding

Class EmptyStatementCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.coding.EmptyStatementCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class EmptyStatementCheck
extends AbstractCheck

Detects empty statements (standalone ";" semicolon). Empty statements often introduce bugs that are hard to spot

Since:

3.1

Nested Class Summary

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

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
EmptyStatementCheck()	Creates a new EmptyStatementCheck instance.

Method Summary

Modifier and Type	Method	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	isEmptyDeclaration(DetailAST semi)	Checks whether a semicolon is a standalone empty declaration, i.e. it appears at the top level of a compilation unit or directly in a type body.
private static boolean	isEnumConstantsTerminator(DetailAST semi)	Checks whether a semicolon in a type body terminates the list of enum constants.
void	visitToken(DetailAST ast)	Called to process a token.

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

beginTree, clearViolations, destroy, finishTree, getFileContents, getFilePath, 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.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Field Details

MSG_KEY

public static final String MSG_KEY

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

See Also:

• Constant Field Values

Constructor Details

EmptyStatementCheck

public EmptyStatementCheck()

Creates a new EmptyStatementCheck instance.

Method Details

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

isEmptyDeclaration

private static boolean isEmptyDeclaration(DetailAST semi)

Checks whether a semicolon is a standalone empty declaration, i.e. it appears at the top level of a compilation unit or directly in a type body.

Parameters:

semi - semicolon token

Returns:

true if semicolon is an empty declaration

isEnumConstantsTerminator

private static boolean isEnumConstantsTerminator(DetailAST semi)

Checks whether a semicolon in a type body terminates the list of enum constants. Such a semicolon is part of the enum syntax and is not an empty declaration.

Parameters:

semi - semicolon token whose parent is an object block

Returns:

true if semicolon terminates the enum constants list