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

Class UnnecessarySemicolonAfterTypeMemberDeclarationCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public final class UnnecessarySemicolonAfterTypeMemberDeclarationCheck
extends AbstractCheck

Checks if unnecessary semicolon is used after type member declaration.

This check is not applicable to empty statements (unnecessary semicolons inside methods or init blocks), EmptyStatement is responsible for it.

• Property tokens - tokens to check Type is java.lang.String[]. Validation type is tokenSet. Default value is: CLASS_DEF, INTERFACE_DEF, ENUM_DEF, ANNOTATION_DEF, VARIABLE_DEF, ANNOTATION_FIELD_DEF, STATIC_INIT, INSTANCE_INIT, CTOR_DEF, METHOD_DEF, ENUM_CONSTANT_DEF, COMPACT_CTOR_DEF, RECORD_DEF.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• unnecessary.semicolon

Since:

8.24

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
UnnecessarySemicolonAfterTypeMemberDeclarationCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkEnumConstant(DetailAST ast)	Checks if enum constant has unnecessary semicolon.
private void	checkTypeDefinition(DetailAST ast)	Checks if type definition has unnecessary semicolon.
private void	checkTypeMember(DetailAST ast)	Checks if type member has unnecessary semicolon.
private void	checkVariableDefinition(DetailAST variableDef)	Checks if variable definition has unnecessary semicolon.
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	isSemicolon(DetailAST ast)	Checks that ast is a semicolon.
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

UnnecessarySemicolonAfterTypeMemberDeclarationCheck

public UnnecessarySemicolonAfterTypeMemberDeclarationCheck()

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

checkTypeMember

private void checkTypeMember(DetailAST ast)

Checks if type member has unnecessary semicolon.

Parameters:

ast - type member

checkTypeDefinition

private void checkTypeDefinition(DetailAST ast)

Checks if type definition has unnecessary semicolon.

Parameters:

ast - type definition

checkVariableDefinition

private void checkVariableDefinition(DetailAST variableDef)

Checks if variable definition has unnecessary semicolon.

Parameters:

variableDef - variable definition

checkEnumConstant

private void checkEnumConstant(DetailAST ast)

Checks if enum constant has unnecessary semicolon.

Parameters:

ast - enum constant

isSemicolon

private static boolean isSemicolon(DetailAST ast)

Checks that ast is a semicolon.

Parameters:

ast - token to check

Returns:

true if ast is semicolon, false otherwise