Enum Class DocumentationPolicy

java.lang.Object
java.lang.Enum<DocumentationPolicy>
oracle.dbtools.plugin.api.http.annotations.DocumentationPolicy
All Implemented Interfaces:
Serializable, Comparable<DocumentationPolicy>, Constable

public enum DocumentationPolicy extends Enum<DocumentationPolicy>
Describes how a resource should be documented.
Author:
cdivilly
  • Enum Constant Details

    • PUBLIC

      public static final DocumentationPolicy PUBLIC
      Any user can see the documentation
    • AUTHORIZED

      public static final DocumentationPolicy AUTHORIZED
      Only authorized users can see the documentation
    • NONE

      public static final DocumentationPolicy NONE
      The resource is not documented
    • INHERIT

      public static final DocumentationPolicy INHERIT
      Use the default value from the enclosing element
  • Field Details

  • Method Details

    • values

      public static DocumentationPolicy[] 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 DocumentationPolicy 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