Package com.qulice.checkstyle.parameters

Class Arguments

java.lang.Object
com.qulice.checkstyle.parameters.Arguments
public class Arguments extends Object
Method or constructor arguments.
Since:
0.18.18

  • Constructor Summary

    Constructors
    Constructor
    Description
    Arguments(com.puppycrawl.tools.checkstyle.api.DetailAST node)
    Secondary ctor.
    Arguments(Parameters parameters)
    Primary ctor.

  • Method Summary

    Modifier and Type
    Method
    Description
    final void
    checkOrder(List<com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag> tags, Consumer<com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag> consumer)
    Checks for consistency the order of arguments and their Javadoc parameters.
    final int
    count()
    Return number of arguments.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Arguments

      public Arguments(com.puppycrawl.tools.checkstyle.api.DetailAST node)
      Secondary ctor.
      Parameters:
      node - Constructor or method definition node.

    • Arguments

      public Arguments(Parameters parameters)
      Primary ctor.
      Parameters:
      parameters - Parameters.

  • Method Details

    • count

      public final int count()
      Return number of arguments.
      Returns:
      Number of arguments.

    • checkOrder

      public final void checkOrder(List<com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag> tags, Consumer<com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocTag> consumer)
      Checks for consistency the order of arguments and their Javadoc parameters.
      Parameters:
      tags - Javadoc parameter tags.
      consumer - Consumer accepts JavadocTag which is located out of order.