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 aLine,
String aTag,
String aTagValue)
Log a message.
|
void |
setTag(String aTag)
Sets the tag to check.
|
void |
setTagFormat(String aFormat)
Set the tag format.
|
void |
setTagSeverity(String aSeverity)
Sets the tag severity level.
|
void |
visitToken(DetailAST aAST)
Called to process a token.
|
beginTree, destroy, finishTree, getClassLoader, getFileContents, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getId, getMessageBundle, getSeverity, getSeverityLevel, log, log, log, log, log, log, log, log, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public void setTag(String aTag) throws org.apache.commons.beanutils.ConversionException
aTag
- tag to checkorg.apache.commons.beanutils.ConversionException
- If the tag is not a valid regular exception.public void setTagFormat(String aFormat) throws org.apache.commons.beanutils.ConversionException
aFormat
- a String
valueorg.apache.commons.beanutils.ConversionException
- unable to parse aFormatpublic final void setTagSeverity(String aSeverity)
SeverityLevel
class.aSeverity
- The new severity levelSeverityLevel
public int[] getDefaultTokens()
getDefaultTokens
in class Check
TokenTypes
public int[] getAcceptableTokens()
getAcceptableTokens
in class Check
TokenTypes
public void visitToken(DetailAST aAST)
visitToken
in class Check
aAST
- the token to processprotected final void logTag(int aLine, String aTag, String aTagValue)
aLine
- the line number where the error was foundaTag
- the javdoc tag to be loggedaTagValue
- the contents of the tagMessageFormat