public class AtclauseOrderCheck extends AbstractJavadocCheck
Checks the order of at-clauses.
The check allows to configure itself by using the following properties:
Default configuration:
<module name="AtclauseOrderCheck">
<property name="tagOrder" value="@author, @version, @param,
@return, @throws, @exception, @see, @since, @serial,
@serialField, @serialData, @deprecated"/>
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
</module>
| Constructor and Description |
|---|
AtclauseOrderCheck() |
| Modifier and Type | Method and Description |
|---|---|
int[] |
getDefaultJavadocTokens()
Returns the default token types a check is interested in.
|
void |
setTagOrder(String order)
Sets custom order of atclauses.
|
void |
setTarget(String target)
Sets custom targets.
|
void |
visitJavadocToken(DetailNode ast)
Called to process a Javadoc token.
|
beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, isCommentNodesRequired, leaveJavadocToken, leaveToken, visitTokendestroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokensgetCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverityconfigure, contextualize, finishLocalSetup, getConfiguration, setupChildpublic AtclauseOrderCheck()
public void setTarget(String target)
target - user's targets.public void setTagOrder(String order)
order - user's order.public int[] getDefaultJavadocTokens()
AbstractJavadocCheckgetDefaultJavadocTokens in class AbstractJavadocCheckJavadocTokenTypespublic void visitJavadocToken(DetailNode ast)
AbstractJavadocCheckvisitJavadocToken in class AbstractJavadocCheckast - the token to processCopyright © 2001–2015. All rights reserved.