com.puppycrawl.tools.checkstyle.checks.javadoc

Class AtclauseOrderCheck

java.lang.Object

com.puppycrawl.tools.checkstyle.api.AutomaticBean

com.puppycrawl.tools.checkstyle.api.AbstractViolationReporter

com.puppycrawl.tools.checkstyle.api.Check

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 at-clauses.

The check allows to configure itself by using the following properties:

• target - allows to specify targets to check at-clauses.
• tagOrder - allows to specify the order by tags.

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>
 

Author:

max

Constructor Summary

Constructors

Constructor and Description
AtclauseOrderCheck()

Method Summary

Methods

Modifier and Type	Method and Description
int[]	getDefaultJavadocTokens() Returns the default token types a check is interested in.
void	setTagOrder(String aOrder) Sets custom order of atclauses.
void	setTarget(String aTarget) Sets custom targets.
void	visitJavadocToken(DetailNode aAst) Called to process a Javadoc token.

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

beginJavadocTree, beginTree, finishJavadocTree, finishTree, getAcceptableTokens, getBlockCommentAst, getDefaultTokens, getRequiredTokens, isCommentNodesRequired, leaveJavadocToken, leaveToken, visitToken

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

destroy, getClassLoader, getFileContents, getLine, getLines, getTabWidth, getTokenNames, init, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens

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

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

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

configure, contextualize, finishLocalSetup, getConfiguration, setupChild

Methods inherited from class java.lang.Object

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

Constructor Detail

AtclauseOrderCheck

public AtclauseOrderCheck()

Method Detail

setTarget

public void setTarget(String aTarget)

Sets custom targets.

Parameters:

aTarget - user's targets.

setTagOrder

public void setTagOrder(String aOrder)

Sets custom order of atclauses.

Parameters:

aOrder - user's order.

getDefaultJavadocTokens

public int[] getDefaultJavadocTokens()

Description copied from class: AbstractJavadocCheck

Returns the default token types a check is interested in.

Specified by:

getDefaultJavadocTokens in class AbstractJavadocCheck

Returns:

the default token types

See Also:

JavadocTokenTypes

visitJavadocToken

public void visitJavadocToken(DetailNode aAst)

Description copied from class: AbstractJavadocCheck

Called to process a Javadoc token.

Overrides:

visitJavadocToken in class AbstractJavadocCheck

Parameters:

aAst - the token to process