Enum RelatedMediaType
- java.lang.Object
-
- java.lang.Enum<RelatedMediaType>
-
- org.odpi.openmetadata.frameworks.connectors.properties.beans.RelatedMediaType
-
- All Implemented Interfaces:
Serializable,Comparable<RelatedMediaType>
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.
-
-
Field Summary
Fields Modifier and Type Field Description static StringENUM_TYPE_GUIDstatic StringENUM_TYPE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringgetDescription()Return the default description for this enum instance.StringgetName()Return the default name for this enum instance.StringgetOpenTypeGUID()Return the unique identifier for the open metadata enum type that this enum class represents.StringgetOpenTypeName()Return the unique name for the open metadata enum type that this enum class represents.intgetOpenTypeOrdinal()Return the code for this enum that comes from the Open Metadata Type that this enum represents.intgetOrdinal()Return the code for this enum instanceStringtoString()Standard toString method.static RelatedMediaTypevalueOf(String name)Returns the enum constant of this type with the specified name.static RelatedMediaType[]values()Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
IMAGE
public static final RelatedMediaType IMAGE
-
AUDIO
public static final RelatedMediaType AUDIO
-
DOCUMENT
public static final RelatedMediaType DOCUMENT
-
VIDEO
public static final RelatedMediaType VIDEO
-
OTHER
public static final RelatedMediaType OTHER
-
-
Field Detail
-
ENUM_TYPE_GUID
public static final String ENUM_TYPE_GUID
- See Also:
- Constant Field Values
-
ENUM_TYPE_NAME
public static final String ENUM_TYPE_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
values
public static RelatedMediaType[] 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 (RelatedMediaType c : RelatedMediaType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static RelatedMediaType valueOf(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:
IllegalArgumentException- if this enum type has no constant with the specified nameNullPointerException- 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:
toStringin classEnum<RelatedMediaType>- Returns:
- print out of variables in a JSON-style
-
-