Package oracle.dbtools.plugin.api.http.annotations

Enum DocumentationPolicy

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DocumentationPolicy>
    public enum DocumentationPolicy
extends java.lang.Enum<DocumentationPolicy>
    Describes how a resource should be documented.
    Author:
    cdivilly

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      AUTHORIZED
      Only authorized users can see the documentation
      INHERIT
      Use the default value from the enclosing element
      NONE
      The resource is not documented
      PUBLIC
      Any user can see the documentation

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DocumentationPolicy valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DocumentationPolicy[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.

      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • AUTHORIZED

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

      • INHERIT

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

    • Method Detail

      • values

        public static DocumentationPolicy[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: 
        for (DocumentationPolicy c : DocumentationPolicy.values())
    System.out.println(c);
        Returns:
        an array containing the constants of this enum type, in the order they are declared

      • valueOf

        public static DocumentationPolicy valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null