com.puppycrawl.tools.checkstyle.checks.javadoc

Class WriteTagCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

com.puppycrawl.tools.checkstyle.checks.javadoc.WriteTagCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class WriteTagCheck
extends Check

Outputs a JavaDoc tag as information. Can be used e.g. with the stylesheets that sort the report by author name. To define the format for a tag, set property tagFormat to a regular expression. This check uses two different severity levels. The normal one is used for reporting when the tag is missing. The additional one (tagSeverity) is used for the level of reporting when the tag exists. The default value for tagSeverity is info.

An example of how to configure the check for printing author name is:

 <module name="WriteTag">
    <property name="tag" value="@author"/>
    <property name="tagFormat" value="\S"/>
 </module>
 

An example of how to configure the check to print warnings if an "@incomplete" tag is found, and not print anything if it is not found:

 <module name="WriteTag">
    <property name="tag" value="@incomplete"/>
    <property name="tagFormat" value="\S"/>
    <property name="severity" value="ignore"/>
    <property name="tagSeverity" value="warning"/>
 </module>
 

Author:

Daniel Grenner

Field Summary

Fields

Modifier and Type	Field and Description
static String	MISSING_TAG A key is pointing to the warning message text in "messages.properties" file.
static String	TAG_FORMAT A key is pointing to the warning message text in "messages.properties" file.
static String	WRITE_TAG A key is pointing to the warning message text in "messages.properties" file.

Constructor Summary

Constructors

Constructor and Description
WriteTagCheck()

Method Summary

Modifier and Type	Method and Description
int[]	getAcceptableTokens() The configurable token set.
int[]	getDefaultTokens() Returns the default token a check is interested in.
protected void	logTag(int line, String tag, String tagValue) Log a message.
void	setTag(String tag) Sets the tag to check.
void	setTagFormat(String format) Set the tag format.
void	setTagSeverity(String severity) Sets the tag severity level.
void	visitToken(DetailAST ast) Called to process a token.

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

beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MISSING_TAG

public static final String MISSING_TAG

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

See Also:

Constant Field Values

WRITE_TAG

public static final String WRITE_TAG

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

See Also:

Constant Field Values

TAG_FORMAT

public static final String TAG_FORMAT

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

See Also:

Constant Field Values

Constructor Detail

WriteTagCheck

public WriteTagCheck()

Method Detail

setTag

public void setTag(String tag)
            throws org.apache.commons.beanutils.ConversionException

Sets the tag to check.

Parameters:

tag - tag to check

Throws:

org.apache.commons.beanutils.ConversionException - if unable to create Pattern object.

setTagFormat

public void setTagFormat(String format)
                  throws org.apache.commons.beanutils.ConversionException

Set the tag format.

Parameters:

format - a String value

Throws:

org.apache.commons.beanutils.ConversionException - if unable to create Pattern object

setTagSeverity

public final void setTagSeverity(String severity)

Sets the tag severity level. The string should be one of the names defined in the SeverityLevel class.

Parameters:

severity - The new severity level

See Also:

SeverityLevel

getDefaultTokens

public int[] getDefaultTokens()

Description copied from class: Check

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 Check

Returns:

the default tokens

See Also:

TokenTypes

getAcceptableTokens

public int[] getAcceptableTokens()

Description copied from class: Check

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 Check

Returns:

the token set this check is designed for.

See Also:

TokenTypes

visitToken

public void visitToken(DetailAST ast)

Description copied from class: Check

Called to process a token.

Overrides:

visitToken in class Check

Parameters:

ast - the token to process

logTag

protected final void logTag(int line,
                            String tag,
                            String tagValue)

Log a message.

Parameters:

line - the line number where the error was found

tag - the javadoc tag to be logged

tagValue - the contents of the tag

See Also:

MessageFormat