Package org.odpi.openmetadata.frameworks.connectors.properties.beans

Enum Class RelatedMediaType

java.lang.Object
java.lang.Enum<RelatedMediaType>
org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedMediaType
All Implemented Interfaces:
Serializable, Comparable<RelatedMediaType>, Constable
public enum RelatedMediaType extends Enum<RelatedMediaType> implements Serializable
The RelatedMediaType defines the type of resource referenced in a related media reference.
  • Image - The media is an image.
  • Audio - The media is an audio recording.
  • Document - The media is a text document - probably rich text.
  • Video - The media is a video recording.
  • Other - The media type is not supported.

  • Enum Constant Details

    • IMAGE

      public static final RelatedMediaType IMAGE
      The media is an image.

    • AUDIO

      public static final RelatedMediaType AUDIO
      The media is an audio recording.

    • DOCUMENT

      public static final RelatedMediaType DOCUMENT
      The media is a text document - probably rich text.

    • VIDEO

      public static final RelatedMediaType VIDEO
      The media is a video recording.

    • OTHER

      public static final RelatedMediaType OTHER
      The media type is not supported.

  • Method Details

    • values

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

    • getOrdinal

      public int getOrdinal()
      Return the code for this enum instance
      Returns:
      int media type code

    • getName

      public String getName()
      Return the default name for this enum instance.
      Returns:
      String default name

    • getDescription

      public String getDescription()
      Return the default description for this enum instance.
      Returns:
      String default 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 String getOpenTypeGUID()
      Return the unique identifier for the open metadata enum type that this enum class represents.
      Returns:
      string guid

    • getOpenTypeName

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

    • toString

      public String toString()
      Standard toString method.
      Overrides:
      toString in class Enum<RelatedMediaType>
      Returns:
      print out of variables in a JSON-style