Package com.puppycrawl.tools.checkstyle.checks.javadoc

Class AtclauseOrderCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.AbstractCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

com.puppycrawl.tools.checkstyle.checks.javadoc.AtclauseOrderCheck

All Implemented Interfaces:

Configurable, Contextualizable

public class AtclauseOrderCheck
extends AbstractJavadocCheck

Checks the order of javadoc block-tags or javadoc tags.

Note: Google used the term "at-clauses" for block tags in their guide till 2017-02-28.

• Property tagOrder - Specify the order by tags. Type is java.lang.String[]. Default value is @author, @deprecated, @exception, @param, @return, @see, @serial, @serialData, @serialField, @since, @throws, @version.
• Property target - Specify block tags targeted. Type is java.lang.String[]. Validation type is tokenTypesSet. Default value is CLASS_DEF, COMPACT_CTOR_DEF, CTOR_DEF, ENUM_DEF, INTERFACE_DEF, METHOD_DEF, RECORD_DEF, VARIABLE_DEF.
• Property violateExecutionOnNonTightHtml - Control when to print violations if the Javadoc being examined by this check violates the tight html rules defined at Tight-HTML Rules. Type is boolean. Default value is false.

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

• at.clause.order
• javadoc.missed.html.close
• javadoc.parse.rule.error
• javadoc.unclosedHtml
• javadoc.wrong.singleton.html.tag

Since:

6.0

Nested Class Summary

Nested classes/interfaces inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

AbstractAutomaticBean.OutputStreamOptions

Field Summary

Fields

Modifier and Type	Field	Description
private static final String[]	DEFAULT_ORDER	Default order of atclauses.
static final String	MSG_KEY	A key is pointing to the warning message text in "messages.properties" file.
private List<String>	tagOrder	Specify the order by tags.
private BitSet	target	Specify block tags targeted.

Fields inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

MSG_JAVADOC_MISSED_HTML_CLOSE, MSG_JAVADOC_PARSE_RULE_ERROR, MSG_JAVADOC_WRONG_SINGLETON_TAG, MSG_KEY_UNCLOSED_HTML_TAG

Constructor Summary

Constructors

Constructor	Description
AtclauseOrderCheck()

Method Summary

Modifier and Type	Method	Description
private void	checkOrderInTagSection(DetailNode javadoc)	Checks order of atclauses in tag section node.
int[]	getDefaultJavadocTokens()	Returns the default javadoc token types a check is interested in.
private static int	getParentType(DetailAST commentBlock)	Returns type of parent node.
int[]	getRequiredJavadocTokens()	The javadoc tokens that this check must be registered for.
void	setTagOrder(String... orders)	Setter to specify the order by tags.
void	setTarget(String... targets)	Setter to specify block tags targeted.
void	visitJavadocToken(DetailNode ast)	Called to process a Javadoc token.

Methods inherited from class com.puppycrawl.tools.checkstyle.checks.javadoc.AbstractJavadocCheck

acceptJavadocWithNonTightHtml, beginJavadocTree, beginTree, destroy, finishJavadocTree, finishTree, getAcceptableJavadocTokens, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, init, isCommentNodesRequired, leaveJavadocToken, setJavadocTokens, setViolateExecutionOnNonTightHtml, visitToken

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractCheck

clearViolations, getFileContents, getFilePath, getLine, getLineCodePoints, getLines, getTabWidth, getTokenNames, getViolations, leaveToken, log, log, log, setFileContents, setTabWidth, setTokens

Methods inherited from class com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

finishLocalSetup, getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, setId, setSeverity

Methods inherited from class com.puppycrawl.tools.checkstyle.AbstractAutomaticBean

configure, contextualize, getConfiguration, setupChild

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

MSG_KEY

public static final String MSG_KEY

A key is pointing to the warning message text in "messages.properties" file.

See Also:

• Constant Field Values

DEFAULT_ORDER

private static final String[] DEFAULT_ORDER

Default order of atclauses.

target

private BitSet target

Specify block tags targeted.

tagOrder

private List<String> tagOrder

Specify the order by tags.

Constructor Details

AtclauseOrderCheck

public AtclauseOrderCheck()

Method Details

setTarget

public void setTarget(String... targets)

Setter to specify block tags targeted.

Parameters:

targets - user's targets.

Since:

6.0

setTagOrder

public void setTagOrder(String... orders)

Setter to specify the order by tags.

Parameters:

orders - user's orders.

Since:

6.0

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default javadoc token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default javadoc token types

See Also:

• JavadocTokenTypes

getRequiredJavadocTokens

public int[] getRequiredJavadocTokens()

Description copied from class: AbstractJavadocCheck

The javadoc tokens that this check must be registered for.

Overrides:

getRequiredJavadocTokens in class AbstractJavadocCheck

Returns:

the javadoc token set this must be registered for.

See Also:

• JavadocTokenTypes

visitJavadocToken

public void visitJavadocToken(DetailNode ast)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Specified by:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

ast - the token to process

checkOrderInTagSection

private void checkOrderInTagSection(DetailNode javadoc)

Checks order of atclauses in tag section node.

Parameters:

javadoc - Javadoc root node.

getParentType

private static int getParentType(DetailAST commentBlock)

Returns type of parent node.

Parameters:

commentBlock - child node.

Returns:

parent type.