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>
AutomaticBean.OutputStreamOptions
Modifier and Type | Field and Description |
---|---|
static String |
MSG_MISSING_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_TAG_FORMAT
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_WRITE_TAG
A key is pointing to the warning message text in "messages.properties"
file.
|
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.
|
int[] |
getRequiredTokens()
The tokens that this check must be registered for.
|
void |
setTag(String tag)
Sets the tag to check.
|
void |
setTagFormat(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, clearMessages, destroy, finishTree, getClassLoader, getFileContents, getLine, getLines, getMessages, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, log, setClassLoader, setFileContents, setTabWidth, setTokens
finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity
configure, contextualize, getConfiguration, setupChild
public static final String MSG_MISSING_TAG
public static final String MSG_WRITE_TAG
public static final String MSG_TAG_FORMAT
public WriteTagCheck()
public void setTagFormat(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 processCopyright © 2001–2018. All rights reserved.