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

Class PreferLiteralJavadocInlineTagCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class PreferLiteralJavadocInlineTagCheck
extends AbstractJavadocCheck

Checks that Javadoc inline tags are preferred over escaping entities. According to OpenJDK Style Guidelines v6 Javadoc inline tags should be preferred over their HTML equivalents. Entities that are flagged by the check are:

• <
• >
• &
• "
• '

Reason of only these entities are flagged is given here : Predefined Entities

Not flagged:

• Content inside <pre> and <code> blocks (code examples)
• Content inside {@code}, {@literal}, {@snippet} inline tags

Since:

13.11.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
private static final List<String>	HTML_ENTITIES	HTML entities to be replaced with {@literal ...}.
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
PreferLiteralJavadocInlineTagCheck()	Creates a new PreferJavadocInlineTagsCheck instance.

Method Summary

Modifier and Type	Method	Description
private void	checkForHtmlEntities(DetailNode textNode)	Checks Javadoc TEXT nodes for HTML entities that should be replaced with {@literal ...}.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
private static String	getHtmlTagName(DetailNode htmlElement)	Gets the tag name from an HTML_ELEMENT node.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
private static boolean	isInsideInlineTag(DetailNode node)	Checks if the node is inside a {@code}, {@literal} or {@snippet} inline tag.
private static boolean	isInsidePreOrCodeTag(DetailNode node)	Checks if the node is inside a pre or code tag.
void	visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.

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

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

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

clearViolations, finishTree, 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

HTML_ENTITIES

private static final List<String> HTML_ENTITIES

HTML entities to be replaced with {@literal ...}.

Constructor Details

PreferLiteralJavadocInlineTagCheck

public PreferLiteralJavadocInlineTagCheck()

Creates a new PreferJavadocInlineTagsCheck instance.

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 ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process

checkForHtmlEntities

private void checkForHtmlEntities(DetailNode textNode)

Checks Javadoc TEXT nodes for HTML entities that should be replaced with {@literal ...}.

Parameters:

textNode - the TEXT node to check

getHtmlTagName

@Nullable
private static String getHtmlTagName(DetailNode htmlElement)

Gets the tag name from an HTML_ELEMENT node.

Parameters:

htmlElement - the HTML_ELEMENT node

Returns:

the tag name (e.g., "code", "a")

isInsidePreOrCodeTag

private static boolean isInsidePreOrCodeTag(DetailNode node)

Checks if the node is inside a pre or code tag.

Parameters:

node - the node to check

Returns:

true if inside a pre or code block

isInsideInlineTag

private static boolean isInsideInlineTag(DetailNode node)

Checks if the node is inside a {@code}, {@literal} or {@snippet} inline tag. Content inside these tags is meant to be displayed literally, so HTML patterns within them are intentional examples and should not be flagged.

Parameters:

node - the node to check

Returns:

true if inside a code, literal or snippet inline tag