Package com.puppycrawl.tools.checkstyle.checks.whitespace

Class MultilineCommentLeadingAsteriskPresenceCheck

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.whitespace.MultilineCommentLeadingAsteriskPresenceCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class MultilineCommentLeadingAsteriskPresenceCheck
extends AbstractCheck

Checks that all lines in a multi-line block comment start with a leading asterisk (*), as required by the Google Java Style Guide §4.8.6.

For multi-line block comments, subsequent lines must start with * aligned with the * on the previous line. This check does not apply to single-line block comments (/* comment */).

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• multiline.comment.missing.asterisk

Since:

13.3.0

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

Constructor Summary

Constructors

Constructor	Description
MultilineCommentLeadingAsteriskPresenceCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkCommentLines(DetailAST ast, String commentText)	Checks each line of the comment for leading asterisks.
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.
boolean	isCommentNodesRequired()	Whether comment nodes are required or not.
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, 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_MISSING_ASTERISK

public static final String MSG_MISSING_ASTERISK

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

See Also:

• Constant Field Values

Constructor Details

MultilineCommentLeadingAsteriskPresenceCheck

public MultilineCommentLeadingAsteriskPresenceCheck()

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

isCommentNodesRequired

public boolean isCommentNodesRequired()

Description copied from class: AbstractCheck

Whether comment nodes are required or not.

Overrides:

isCommentNodesRequired in class AbstractCheck

Returns:

false as a default value.

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

checkCommentLines

private void checkCommentLines(DetailAST ast,
 String commentText)

Checks each line of the comment for leading asterisks.

Parameters:

ast - the block comment AST node

commentText - the text of the comment