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 and Description
ICON
ILLUSTRATION
OTHER
THUMBNAIL
USAGE_GUIDANCE

Method Summary

Modifier and Type	Method and 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.
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

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

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<RelatedMediaUsage>

Returns:

print out of variables in a JSON-style