Enum CollectionOrder

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CollectionOrder>

    public enum CollectionOrder
    extends java.lang.Enum<CollectionOrder>
    implements java.io.Serializable
    CollectionOrder specifies the sequencing to use in a specific collection.
    • QUALIFIED_NAME - Order the collection by the qualified name of the members in the collection.
    • NAME - Order the collection by the name of the members in the collection.
    • OWNER - Order the collection by the owner of the members in the collection.
    • DATE_ADDED - Order the collection by the date that the members were added to the collection.
    • DATE_UPDATED - Order the collection by the date that the members were updated in the collection.
    • DATE_CREATED - Order the collection by the date that the members were created in the collection.
    • OTHER - Order the collection by another value.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getDescription()
      Return the default description of the enumeration.
      java.lang.String getName()
      Return the default name of the enumeration.
      java.lang.String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      java.lang.String getOpenTypeName()
      Return the unique name for the open metadata enum type that this enum class represents.
      int getOpenTypeOrdinal()
      Return the code for this enum that comes from the Open Metadata Type that this enum represents.
      int getOrdinal()
      Return the numeric representation of the enumeration.
      java.lang.String toString()
      toString() JSON-style
      static CollectionOrder valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static CollectionOrder[] 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, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Method Detail

      • values

        public static CollectionOrder[] 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 (CollectionOrder c : CollectionOrder.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static CollectionOrder 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
      • getOrdinal

        public int getOrdinal()
        Return the numeric representation of the enumeration.
        Returns:
        int ordinal
      • getName

        public java.lang.String getName()
        Return the default name of the enumeration.
        Returns:
        String name
      • getDescription

        public java.lang.String getDescription()
        Return the default description of the enumeration.
        Returns:
        String description
      • getOpenTypeOrdinal

        public int getOpenTypeOrdinal()
        Return the code for this enum that comes from the Open Metadata Type that this enum represents.
        Returns:
        int code number
      • getOpenTypeGUID

        public java.lang.String getOpenTypeGUID()
        Return the unique identifier for the open metadata enum type that this enum class represents.
        Returns:
        string guid
      • getOpenTypeName

        public java.lang.String getOpenTypeName()
        Return the unique name for the open metadata enum type that this enum class represents.
        Returns:
        string name
      • toString

        public java.lang.String toString()
        toString() JSON-style
        Overrides:
        toString in class java.lang.Enum<CollectionOrder>
        Returns:
        string description