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

Enum RelatedMediaUsage

java.lang.Object

java.lang.Enum<RelatedMediaUsage>

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

All Implemented Interfaces:

Serializable, Comparable<RelatedMediaUsage>

public enum RelatedMediaUsage
extends Enum<RelatedMediaUsage>
implements Serializable

The RelatedMediaUsage defines how a related media reference can be used in conjunction with the asset properties. These usage options are not mutually exclusive.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ICON
ILLUSTRATION
OTHER
THUMBNAIL
USAGE_GUIDANCE

Field Summary

Fields

Modifier and Type	Field	Description
static String	ENUM_TYPE_GUID
static String	ENUM_TYPE_NAME

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the media usage pattern for this enum instance.
String	getName()	Return the default name for this enum instance.
String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
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 code for this enum instance
String	toString()	Standard toString method.
static RelatedMediaUsage	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RelatedMediaUsage[]	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

Enum Constant Detail

ICON

public static final RelatedMediaUsage ICON

THUMBNAIL

public static final RelatedMediaUsage THUMBNAIL

ILLUSTRATION

public static final RelatedMediaUsage ILLUSTRATION

USAGE_GUIDANCE

public static final RelatedMediaUsage USAGE_GUIDANCE

OTHER

public static final RelatedMediaUsage 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 RelatedMediaUsage[] 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 (RelatedMediaUsage c : RelatedMediaUsage.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static RelatedMediaUsage 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 name

NullPointerException - if the argument is null

getOrdinal

public int getOrdinal()

Return the code for this enum instance

Returns:

int media usage 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 the media usage pattern 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<RelatedMediaUsage>

Returns:

print out of variables in a JSON-style