public class WriteTagCheck extends AbstractCheck
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>
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties"
file.
|
static java.lang.String |
MSG_WRITE_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
private java.lang.String |
tag
Regexp to match tag.
|
private java.util.regex.Pattern |
tagFormat
Compiled regexp to match tag content.
|
private java.util.regex.Pattern |
tagRegExp
Compiled regexp to match tag.
|
private SeverityLevel |
tagSeverity
The severity level of found tag reports.
|
Constructor and Description |
---|
WriteTagCheck() |
Modifier and Type | Method and Description |
---|---|
private void |
checkTag(int lineNo,
java.lang.String... comment)
Verifies that a type definition has a required tag.
|
int[] |
getAcceptableTokens()
The configurable token set.
|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
protected void |
logTag(int line,
java.lang.String tagName,
java.lang.String tagValue)
Log a message.
|
void |
setTag(java.lang.String tag)
Sets the tag to check.
|
void |
setTagFormat(java.util.regex.Pattern pattern)
Set the tag format.
|
void |
setTagSeverity(SeverityLevel severity)
Sets the tag severity level.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, 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 static final java.lang.String MSG_MISSING_TAG
public static final java.lang.String MSG_WRITE_TAG
public static final java.lang.String MSG_TAG_FORMAT
private java.util.regex.Pattern tagRegExp
private java.util.regex.Pattern tagFormat
private java.lang.String tag
private SeverityLevel tagSeverity
public void setTag(java.lang.String tag)
tag
- tag to checkpublic void setTagFormat(java.util.regex.Pattern pattern)
pattern
- a String
valuepublic final void setTagSeverity(SeverityLevel severity)
severity
- The new severity levelSeverityLevel
public int[] getDefaultTokens()
AbstractCheck
getDefaultTokens
in class AbstractCheck
TokenTypes
public int[] getAcceptableTokens()
AbstractCheck
getAcceptableTokens
in class AbstractCheck
TokenTypes
public int[] getRequiredTokens()
AbstractCheck
getRequiredTokens
in class AbstractCheck
TokenTypes
public void visitToken(DetailAST ast)
AbstractCheck
visitToken
in class AbstractCheck
ast
- the token to processprivate void checkTag(int lineNo, java.lang.String... comment)
lineNo
- the line number for the type definition.comment
- the Javadoc comment for the type definition.protected final void logTag(int line, java.lang.String tagName, java.lang.String tagValue)
line
- the line number where the error was foundtagName
- the javadoc tag to be loggedtagValue
- the contents of the tagMessageFormat