Enum Class MediaUsage
- All Implemented Interfaces:
Serializable
,Comparable<MediaUsage>
,Constable
,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 ConstantsEnum ConstantDescriptionProvides a small image to represent the asset in tree views and graphs.Illustrates how the asset works or what it contains.Another usage.Provides a small image about the asset that can be used in lists.Provides guidance to a person on how to use the asset. -
Method Summary
Modifier and TypeMethodDescriptionReturn the default description for the media usage pattern for this enum instance.Return the unique identifier for the valid value that represents the enum value.getName()
Return the default name for this enum instance.static String
Return the description for the open metadata enum type that this enum class represents.static String
Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.static String
Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.static String
Return the unique identifier for the open metadata enum type that this enum class represents.static String
Return the unique name for the open metadata enum type that this enum class represents.int
Return the code for this enum instanceboolean
Return whether the enum is the default value or not.toString()
Standard toString method.static MediaUsage
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.
-
Enum Constant Details
-
ICON
Provides a small image to represent the asset in tree views and graphs. -
THUMBNAIL
Provides a small image about the asset that can be used in lists. -
ILLUSTRATION
Illustrates how the asset works or what it contains. It is complementary to the asset's description. -
USAGE_GUIDANCE
Provides guidance to a person on how to use the asset. -
OTHER
Another usage.
-
-
Method Details
-
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
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 nameNullPointerException
- if the argument is null
-
getOrdinal
public int getOrdinal()Return the code for this enum instance- Specified by:
getOrdinal
in interfaceOpenMetadataEnum
- Returns:
- int media usage code
-
getName
Return the default name for this enum instance.- Specified by:
getName
in interfaceOpenMetadataEnum
- Returns:
- String default name
-
getDescription
Return the default description for the media usage pattern for this enum instance.- Specified by:
getDescription
in interfaceOpenMetadataEnum
- Returns:
- String default description
-
getDescriptionGUID
Return the unique identifier for the valid value that represents the enum value.- Specified by:
getDescriptionGUID
in interfaceOpenMetadataEnum
- Returns:
- guid
-
isDefault
public boolean isDefault()Return whether the enum is the default value or not.- Specified by:
isDefault
in interfaceOpenMetadataEnum
- Returns:
- boolean
-
getOpenTypeGUID
Return the unique identifier for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
getOpenTypeName
Return the unique name for the open metadata enum type that this enum class represents.- Returns:
- string name
-
getOpenTypeDescription
Return the description for the open metadata enum type that this enum class represents.- Returns:
- string description
-
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
Return the unique identifier for the valid value element for the open metadata enum type that this enum class represents.- Returns:
- string guid
-
toString
Standard toString method.- Overrides:
toString
in classEnum<MediaUsage>
- Returns:
- print out of variables in a JSON-style
-