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

Class WriteTagCheck

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

All Implemented Interfaces:

Configurable, Contextualizable

public class WriteTagCheck
extends AbstractJavadocCheck

Requires user defined Javadoc tag to be present in Javadoc comment with defined format. To define the format for a tag, set property tagFormat to a regular expression. Violations are reported only when the configured tag is missing or when the tag content does not match tagFormat. No violation is reported when the tag is present and matches tagFormat (or when tagFormat is not configured). No violation reported in case there is no javadoc. To forbid tags instead of requiring them, use IllegalBlockTag.

Since:

4.2

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_TAG	A key is pointing to the warning message text in "messages.properties" file.
static final String	MSG_TAG_FORMAT	A key is pointing to the warning message text in "messages.properties" file.
private DetailAST	parentAst	Parent AST for the missing tag report in the current Javadoc tree.
private String	tag	Specify the name of tag.
private Pattern	tagFormat	Specify the regexp to match tag content.
private boolean	tagFound	Whether the target tag was found in the current Javadoc tree.

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
WriteTagCheck()	Creates a new WriteTagCheck instance.

Method Summary

Modifier and Type	Method	Description
void	beginJavadocTree(DetailNode rootAst)	Called before the starting to process a tree.
private static DetailAST	findJavadoc(DetailAST ast)	Finds the Javadoc comment associated with a structural AST node.
void	finishJavadocTree(DetailNode rootAst)	Called after finished processing a tree.
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
private static String	getTagContent(DetailNode javadocBlockTagNode)	Returns the raw content of the tag.
void	setTag(String tag)	Setter to specify the name of tag.
void	setTagFormat(Pattern pattern)	Setter to specify the regexp to match tag content.
void	setViolateExecutionOnNonTightHtml(boolean shouldReportViolation)	Setter to control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules.
void	visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.
void	visitToken(DetailAST ast)	Called to process a token.

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

acceptJavadocWithNonTightHtml, beginTree, destroy, getAcceptableJavadocTokens, getBlockCommentAst, init, isCommentNodesRequired, leaveJavadocToken, log, setJavadocTokens

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_MISSING_TAG

public static final String MSG_MISSING_TAG

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

See Also:

• Constant Field Values

MSG_TAG_FORMAT

public static final String MSG_TAG_FORMAT

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

See Also:

• Constant Field Values

tagFormat

private Pattern tagFormat

Specify the regexp to match tag content.

tag

private String tag

Specify the name of tag.

tagFound

private boolean tagFound

Whether the target tag was found in the current Javadoc tree.

parentAst

private DetailAST parentAst

Parent AST for the missing tag report in the current Javadoc tree.

Constructor Details

WriteTagCheck

public WriteTagCheck()

Creates a new WriteTagCheck instance.

Method Details

setTag

public void setTag(String tag)

Setter to specify the name of tag.

Parameters:

tag - tag to check

Since:

4.2

setTagFormat

public void setTagFormat(Pattern pattern)

Setter to specify the regexp to match tag content.

Parameters:

pattern - a String value

Since:

4.2

setViolateExecutionOnNonTightHtml

public void setViolateExecutionOnNonTightHtml(boolean shouldReportViolation)

Setter to control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules.

Overrides:

setViolateExecutionOnNonTightHtml in class AbstractJavadocCheck

Parameters:

shouldReportViolation - value to which the field shall be set to

Since:

8.3

getRequiredTokens

public int[] getRequiredTokens()

Description copied from class: AbstractCheck

The tokens that this check must be registered for.

Overrides:

getRequiredTokens in class AbstractJavadocCheck

Returns:

the token set this must be registered for.

See Also:

• TokenTypes

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.

Overrides:

getDefaultTokens in class AbstractJavadocCheck

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.

Overrides:

getAcceptableTokens in class AbstractJavadocCheck

Returns:

the token set this check is designed for.

See Also:

• TokenTypes

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

visitToken

public void visitToken(DetailAST ast)

Description copied from class: AbstractCheck

Called to process a token.

Overrides:

visitToken in class AbstractJavadocCheck

Parameters:

ast - the token to process

beginJavadocTree

public void beginJavadocTree(DetailNode rootAst)

Description copied from class: AbstractJavadocCheck

Called before the starting to process a tree.

Overrides:

beginJavadocTree in class AbstractJavadocCheck

Parameters:

rootAst - the root of the tree

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

finishJavadocTree

public void finishJavadocTree(DetailNode rootAst)

Description copied from class: AbstractJavadocCheck

Called after finished processing a tree.

Overrides:

finishJavadocTree in class AbstractJavadocCheck

Parameters:

rootAst - the root of the tree

getTagContent

private static String getTagContent(DetailNode javadocBlockTagNode)

Returns the raw content of the tag.

Parameters:

javadocBlockTagNode - The node representing a Javadoc block tag. This node must be of type JavadocCommentsTokenTypes.JAVADOC_BLOCK_TAG

Returns:

The raw content of the tag.

findJavadoc

@Nullable
private static DetailAST findJavadoc(DetailAST ast)

Finds the Javadoc comment associated with a structural AST node.

Parameters:

ast - the structural node (e.g., CLASS_DEF, METHOD_DEF)

Returns:

the Javadoc block comment if found, or null