Class 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 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.
  • Property target - Specify the list of block tags targeted. Type is java.lang.String[]. Validation type is tokenTypesSet. Default value is CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF, RECORD_DEF, COMPACT_CTOR_DEF.
  • 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.

To configure the default check:

 <module name="AtclauseOrder"/>
 

Example:

 /**
 * Some javadoc. // OK
 *
 * @author Some javadoc. // OK
 * @version Some javadoc. // OK
 * @param Some javadoc. // OK
 * @return Some javadoc. // OK
 * @throws Some javadoc. // OK
 * @exception Some javadoc. // OK
 * @see Some javadoc. // OK
 * @since Some javadoc. // OK
 * @serial Some javadoc. // OK
 * @serialField // OK
 * @serialData // OK
 * @deprecated Some javadoc. // OK
 */

 class Valid implements Serializable
 {
 }

 /**
 * Some javadoc.
 *
 * @since Some javadoc. // OK
 * @version Some javadoc. // Violation - wrong order
 * @deprecated
 * @see Some javadoc. // Violation - wrong order
 * @author Some javadoc. // Violation - wrong order
 */

 class Invalid implements Serializable
 {
 }
 

Parent is com.puppycrawl.tools.checkstyle.TreeWalker

Violation Message Keys:

  • at.clause.order
  • javadoc.missed.html.close
  • javadoc.parse.rule.error
  • javadoc.wrong.singleton.html.tag
Since:
6.0
  • 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:
    • DEFAULT_ORDER

      private static final String[] DEFAULT_ORDER
      Default order of atclauses.
    • target

      private List<Integer> target
      Specify the list of 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 the list of block tags targeted.
      Parameters:
      targets - user's targets.
    • setTagOrder

      public void setTagOrder(String... orders)
      Setter to specify the order by tags.
      Parameters:
      orders - user's orders.
    • 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:
    • 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:
    • 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.