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

Class UnnecessarySemicolonInEnumerationCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public final class UnnecessarySemicolonInEnumerationCheck
extends AbstractCheck

Checks if unnecessary semicolon is in enum definitions. Semicolon is not needed if enum body contains only enum constants.

Since:

8.22

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_SEMI	A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor	Description
UnnecessarySemicolonInEnumerationCheck()

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	hasMembersAfterConstants(DetailAST enumBlock)	Checks if enum body contains any member (method, constructor, field, etc.)
private static boolean	isPrecededBySemi(DetailAST ast)	Checks if semicolon is immediately preceded by another semicolon, making it a redundant duplicate.
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_SEMI

public static final String MSG_SEMI

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

See Also:

• Constant Field Values

Constructor Details

UnnecessarySemicolonInEnumerationCheck

public UnnecessarySemicolonInEnumerationCheck()

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

hasMembersAfterConstants

private static boolean hasMembersAfterConstants(DetailAST enumBlock)

Checks if enum body contains any member (method, constructor, field, etc.) in addition to enum constants and semicolons.

Parameters:

enumBlock - the enum body to check

Returns:

true if enum body has members, false if it only has constants and semicolons.

isPrecededBySemi

private static boolean isPrecededBySemi(DetailAST ast)

Checks if semicolon is immediately preceded by another semicolon, making it a redundant duplicate.

Parameters:

ast - semicolon to check

Returns:

true if previous sibling is also a semicolon, false otherwise.