Package org.odpi.openmetadata.accessservices.subjectarea.properties.enums

Enum MediaUsage

java.lang.Object

java.lang.Enum<MediaUsage>

org.odpi.openmetadata.accessservices.subjectarea.properties.enums.MediaUsage

All Implemented Interfaces:

Serializable, Comparable<MediaUsage>

public enum MediaUsage
extends Enum<MediaUsage>
implements Serializable

Defines how a related media reference should be used.

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.
UsageGuidance	Provides guidance to a person on how to use the asset.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description for the enum.
String	getName()	Return the descriptive name for the MediaUsage enum instance
int	getOrdinal()	Return the numerical value for the enum.
static MediaUsage	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MediaUsage[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

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.

UsageGuidance

public static final MediaUsage UsageGuidance

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

Other

public static final MediaUsage Other

Another usage.

Method Detail

values

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

Returns:

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

valueOf

public static MediaUsage 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 numerical value for the enum.

Returns:

int enum value ordinal

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

getName

public String getName()

Return the descriptive name for the MediaUsage enum instance

Returns:

String name