Enum Class JavadocSeeTagOrderCheck.Category

java.lang.Object
java.lang.Enum<JavadocSeeTagOrderCheck.Category>
com.puppycrawl.tools.checkstyle.checks.javadoc.JavadocSeeTagOrderCheck.Category
All Implemented Interfaces:
Serializable, Comparable<JavadocSeeTagOrderCheck.Category>, Constable
Enclosing class:
JavadocSeeTagOrderCheck

private static enum JavadocSeeTagOrderCheck.Category extends Enum<JavadocSeeTagOrderCheck.Category>
Category of a @see reference, ordered from the closest to the most distant access.
  • Enum Constant Details

  • Field Details

    • structuralOrder

      private final int structuralOrder
      Explicit structural order, independent of the enum's declaration order.
  • Constructor Details

    • Category

      private Category(int order)
      Creates a new Category instance.
      Parameters:
      order - the explicit structural order
  • Method Details

    • values

      public static JavadocSeeTagOrderCheck.Category[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static JavadocSeeTagOrderCheck.Category valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • order

      int order()
      Returns the explicit structural order.
      Returns:
      the structural order