Package org.odpi.openmetadata.frameworks.openmetadata.enums

Enum Class MediaUsage

java.lang.Object

java.lang.Enum<MediaUsage>

org.odpi.openmetadata.frameworks.openmetadata.enums.MediaUsage

All Implemented Interfaces:

Serializable, Comparable<MediaUsage>, Constable, OpenMetadataEnum

public enum MediaUsage
extends Enum<MediaUsage>
implements OpenMetadataEnum

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ICON	Provides a small image to represent the asset in tree views and graphs.
ILLUSTRATION	Illustrates how the asset works or what it contains.
OTHER	Another usage.
THUMBNAIL	Provides a small image about the asset that can be used in lists.
USAGE_GUIDANCE	Provides guidance to a person on how to use the asset.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the default description for the media usage pattern for this enum instance.
String	getDescriptionGUID()	Return the unique identifier for the valid value that represents the enum value.
String	getName()	Return the default name for this enum instance.
static String	getOpenTypeDescription()	Return the description for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionGUID()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeDescriptionWiki()	Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.
static String	getOpenTypeGUID()	Return the unique identifier for the open metadata enum type that this enum class represents.
static String	getOpenTypeName()	Return the unique name for the open metadata enum type that this enum class represents.
int	getOrdinal()	Return the code for this enum instance
boolean	isDefault()	Return whether the enum is the default value or not.
String	toString()	Standard toString method.
static MediaUsage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MediaUsage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ICON

public static final MediaUsage ICON

Provides a small image to represent the asset in tree views and graphs.

THUMBNAIL

public static final MediaUsage THUMBNAIL

Provides a small image about the asset that can be used in lists.

ILLUSTRATION

public static final MediaUsage ILLUSTRATION

Illustrates how the asset works or what it contains. It is complementary to the asset's description.

USAGE_GUIDANCE

public static final MediaUsage USAGE_GUIDANCE

Provides guidance to a person on how to use the asset.

OTHER

public static final MediaUsage OTHER

Another usage.

Method Details

values

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

Specified by:

getOrdinal in interface OpenMetadataEnum

Returns:

int media usage code

getName

public String getName()

Return the default name for this enum instance.

Specified by:

getName in interface OpenMetadataEnum

Returns:

String default name

getDescription

public String getDescription()

Return the default description for the media usage pattern for this enum instance.

Specified by:

getDescription in interface OpenMetadataEnum

Returns:

String default description

getDescriptionGUID

public String getDescriptionGUID()

Return the unique identifier for the valid value that represents the enum value.

Specified by:

getDescriptionGUID in interface OpenMetadataEnum

Returns:

guid

isDefault

public boolean isDefault()

Return whether the enum is the default value or not.

Specified by:

isDefault in interface OpenMetadataEnum

Returns:

boolean

getOpenTypeGUID

public static String getOpenTypeGUID()

Return the unique identifier for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeName

public static String getOpenTypeName()

Return the unique name for the open metadata enum type that this enum class represents.

Returns:

string name

getOpenTypeDescription

public static String getOpenTypeDescription()

Return the description for the open metadata enum type that this enum class represents.

Returns:

string description

getOpenTypeDescriptionGUID

public static String getOpenTypeDescriptionGUID()

Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.

Returns:

string guid

getOpenTypeDescriptionWiki

public static String getOpenTypeDescriptionWiki()

Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.

Returns:

string guid

toString

public String toString()

Standard toString method.

Overrides:

toString in class Enum<MediaUsage>

Returns:

print out of variables in a JSON-style