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

All Implemented Interfaces:

Configurable, Contextualizable

public class WriteTagCheck
extends AbstractCheck

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. Property tagSeverity is used for severity of events when the tag exists. No violation reported in case there is no javadoc.

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
private static final Pattern	LINE_SPLIT_PATTERN	Line split pattern.
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.
static final String	MSG_WRITE_TAG	A key is pointing to the warning message text in "messages.properties" file.
private String	tag	Specify the name of tag.
private Pattern	tagFormat	Specify the regexp to match tag content.
private Pattern	tagRegExp	Compiled regexp to match tag.
private SeverityLevel	tagSeverity	Specify the severity level when tag is found and printed.

Constructor Summary

Constructors

Constructor	Description
WriteTagCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkTag(int astLineNo, int javadocLineNo, String... comment)	Validates the Javadoc comment against the configured requirements.
private static int	countCommentLines(DetailAST blockComment)	Counts the number of lines in a block comment.
int[]	getAcceptableTokens()	The configurable token set.
int[]	getDefaultTokens()	Returns the default token a check is interested in.
private static DetailAST	getJavadoc(DetailAST ast)	Retrieves the Javadoc comment associated with a given AST node.
int[]	getRequiredTokens()	The tokens that this check must be registered for.
boolean	isCommentNodesRequired()	Whether comment nodes are required or not.
private void	logTag(int line, String tagName, String tagValue)	Log a message.
void	setTag(String tag)	Setter to specify the name of tag.
void	setTagFormat(Pattern pattern)	Setter to specify the regexp to match tag content.
final void	setTagSeverity(SeverityLevel severity)	Setter to specify the severity level when tag is found and printed.
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_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_WRITE_TAG

public static final String MSG_WRITE_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

LINE_SPLIT_PATTERN

private static final Pattern LINE_SPLIT_PATTERN

Line split pattern.

tagRegExp

private Pattern tagRegExp

Compiled regexp to match tag.

tagFormat

private Pattern tagFormat

Specify the regexp to match tag content.

tag

private String tag

Specify the name of tag.

tagSeverity

private SeverityLevel tagSeverity

Specify the severity level when tag is found and printed.

Constructor Details

WriteTagCheck

public WriteTagCheck()

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

setTagSeverity

public final void setTagSeverity(SeverityLevel severity)

Setter to specify the severity level when tag is found and printed.

Parameters:

severity - The new severity level

Since:

4.2

See Also:

• SeverityLevel

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

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.

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

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

getJavadoc

@Nullable
private static DetailAST getJavadoc(DetailAST ast)

Retrieves the Javadoc comment associated with a given AST node.

Parameters:

ast - the AST node (e.g., class, method, constructor) to search above.

Returns:

the DetailAST representing the Javadoc comment if found and valid; null otherwise.

countCommentLines

private static int countCommentLines(DetailAST blockComment)

Counts the number of lines in a block comment.

Parameters:

blockComment - the AST node representing the block comment.

Returns:

the number of lines in the comment.

checkTag

private void checkTag(int astLineNo,
 int javadocLineNo,
 String... comment)

Validates the Javadoc comment against the configured requirements.

Parameters:

astLineNo - the line number of the type definition.

javadocLineNo - the starting line number of the Javadoc comment block.

comment - the lines of the Javadoc comment block.

logTag

private void logTag(int line,
 String tagName,
 String tagValue)

Log a message.

Parameters:

line - the line number where the violation was found

tagName - the javadoc tag to be logged

tagValue - the contents of the tag

See Also:

• MessageFormat