Enum Class Document.Type

java.lang.Object
java.lang.Enum<Document.Type>
org.apache.rat.api.Document.Type
All Implemented Interfaces:
Serializable, Comparable<Document.Type>, Constable
Enclosing class:
Document
public static enum Document.Type extends Enum<Document.Type>
An enumeration of document types.

  • Enum Constant Details

    • ARCHIVE

      public static final Document.Type ARCHIVE
      An archive type document.

    • BINARY

      public static final Document.Type BINARY
      A binary file.

    • IGNORED

      public static final Document.Type IGNORED
      A generated document that is ignored.

    • NOTICE

      public static final Document.Type NOTICE
      A notice document (e.g. LICENSE file).

    • STANDARD

      public static final Document.Type STANDARD
      A standard document.

    • UNKNOWN

      public static final Document.Type UNKNOWN
      An unknown document type.

  • Method Details

    • values

      public static Document.Type[] 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 Document.Type 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