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

Class JavadocMissingLeadingAsteriskCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class JavadocMissingLeadingAsteriskCheck
extends AbstractJavadocCheck

Checks if the javadoc has leading asterisks on each line.

The check does not require asterisks on the first line, nor on the last line if it is blank. All other lines in a Javadoc should start with *, including blank lines and code blocks.

• Property violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type is boolean. Default value is false.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• javadoc.missed.html.close
• javadoc.missing.asterisk
• javadoc.parse.rule.error
• javadoc.unclosedHtml
• javadoc.wrong.singleton.html.tag

Since:

8.38

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 String	MSG_MISSING_ASTERISK	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_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG, MSG_KEY_UNCLOSED_HTML_TAG

Constructor Summary

Constructors

Constructor	Description
JavadocMissingLeadingAsteriskCheck()

Method Summary

Modifier and Type	Method	Description
int[]	getAcceptableJavadocTokens()	The configurable javadoc token set.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
private static DetailNode	getNextNode(DetailNode detailNode)	Gets next node in the ast (sibling or parent sibling for the last node).
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
private static boolean	isLastLine(DetailNode detailNode)	Checks whether this node is the end of a Javadoc comment, optionally preceded by blank text.
private static boolean	isLeadingAsterisk(DetailNode detailNode)	Checks whether the given node is a leading asterisk.
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, 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 Detail

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 Detail

JavadocMissingLeadingAsteriskCheck

public JavadocMissingLeadingAsteriskCheck()

Method Detail

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:

JavadocTokenTypes

getAcceptableJavadocTokens

public int[] getAcceptableJavadocTokens()

Description copied from class: AbstractJavadocCheck

The configurable javadoc token set. Used to protect Checks against malicious users who specify an unacceptable javadoc token set in the configuration file. The default implementation returns the check's default javadoc tokens.

Overrides:

getAcceptableJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this check is designed for.

See Also:

JavadocTokenTypes

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:

JavadocTokenTypes

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

getNextNode

private static DetailNode getNextNode(DetailNode detailNode)

Gets next node in the ast (sibling or parent sibling for the last node).

Parameters:

detailNode - the node to process

Returns:

next node.

isLeadingAsterisk

private static boolean isLeadingAsterisk(DetailNode detailNode)

Checks whether the given node is a leading asterisk.

Parameters:

detailNode - the node to process

Returns:

true if the node is JavadocTokenTypes.LEADING_ASTERISK

isLastLine

private static boolean isLastLine(DetailNode detailNode)

Checks whether this node is the end of a Javadoc comment, optionally preceded by blank text.

Parameters:

detailNode - the node to process

Returns:

true if the node is JavadocTokenTypes.EOF