Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class JavadocMissingWhitespaceAfterAsteriskCheck

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.javadoc.AbstractJavadocCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocMissingWhitespaceAfterAsteriskCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocMissingWhitespaceAfterAsteriskCheck
extends AbstractJavadocCheck

Checks that there is at least one whitespace after the leading asterisk. Although spaces after asterisks are optional in the Javadoc comments, their absence makes the documentation difficult to read. It is the de facto standard to put at least one whitespace after the leading asterisk.

Since:

8.32

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.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

MSG_JAVADOC_PARSE_RULE_ERROR, MSG_KEY_UNCLOSED_HTML_TAG

Constructor Summary

Constructors

Constructor	Description
JavadocMissingWhitespaceAfterAsteriskCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
private static int	getLastLeadingAsteriskPosition(String text)	Finds the position of the last leading asterisk in the string.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
private static boolean	isLast(int position, String text)	Checks if the character position is the last one of the string.
private static DetailNode	resolveNextNode(DetailNode detailNode)	Resolves the first child node related to the given Javadoc DetailNode.
void	visitJavadocToken(DetailNode detailNode)	Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitToken

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

clearViolations, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, 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

JavadocMissingWhitespaceAfterAsteriskCheck

public JavadocMissingWhitespaceAfterAsteriskCheck()

Method Details

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default javadoc token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default javadoc token types

See Also:

• JavadocCommentsTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

• JavadocCommentsTokenTypes

visitJavadocToken

public void visitJavadocToken(DetailNode detailNode)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

detailNode - the token to process

resolveNextNode

private static DetailNode resolveNextNode(DetailNode detailNode)

Resolves the first child node related to the given Javadoc DetailNode.

The resolution works in two steps:

• If the current node is of type JAVADOC_CONTENT, use its first child; otherwise use its next sibling.
• If that base node has a first child, return it regardless of its type.

The returned node may or may not be of type TEXT. If it is not, the violation logic will treat it as a violation later.

Parameters:

detailNode - the Javadoc node to resolve from

Returns:

the first child node if available; otherwise null

isLast

private static boolean isLast(int position,
 String text)

Checks if the character position is the last one of the string.

Parameters:

position - the position of the character

text - String literal.

Returns:

true if the character position is the last one of the string.

getLastLeadingAsteriskPosition

private static int getLastLeadingAsteriskPosition(String text)

Finds the position of the last leading asterisk in the string. If text contains no leading asterisk, -1 will be returned.

Parameters:

text - String literal.

Returns:

the index of the last leading asterisk.