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>
Constructor and Description |
---|
WriteTagCheck() |
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.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public WriteTagCheck()
public void setTag(String tag) throws org.apache.commons.beanutils.ConversionException
tag
- tag to checkorg.apache.commons.beanutils.ConversionException
- If the tag is not a valid regular exception.public void setTagFormat(String format) throws org.apache.commons.beanutils.ConversionException
format
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse formatpublic final void setTagSeverity(String severity)
SeverityLevel
class.severity
- The new severity levelSeverityLevel
public int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
Check
getAcceptableTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processprotected final void logTag(int line, String tag, String tagValue)
line
- the line number where the error was foundtag
- the javadoc tag to be loggedtagValue
- the contents of the tagMessageFormat
Copyright © 2001–2015. All rights reserved.