Package com.mayam.wf.attributes.shared

Enum Class Variety

java.lang.Object

java.lang.Enum<Variety>

com.mayam.wf.attributes.shared.Variety

All Implemented Interfaces:

Serializable, Comparable<Variety>, Constable

public enum Variety
extends Enum<Variety>

Used for generic classes and/or wrapper classes of primitive types to narrow down their use as value classes for attributes, making it easier to find a good widget representation.

Author:

Markus Mårtensson

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	Variety.ValueClass	The value class for the variety.

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

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSET_IDENTITY	Asset identifier string which, when used together with an AssetType, uniquely identifies an asset.
ASSET_SITE_IDENTITY	Asset identifier string typically meant for human eyes.
DURATION_MS	Duration in milliseconds.
EXPRESSION	Typically no value expected, but an expression found in the default value is instead used which operates on the subject as a whole.
JSON	JSON data.
NONE	No particular distinction.
PERCENT
SIZE_BYTES	File size in bytes
TIMECODED_TEXT

Method Summary

Modifier and Type	Method	Description
static Variety	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Variety[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final Variety NONE

No particular distinction. Used as default value of Declare.variety() for the majority of cases where a distinction is not necessary or where the value class itself provides a sufficient one.

ASSET_IDENTITY

@ValueClass(java.lang.String.class)
public static final Variety ASSET_IDENTITY

Asset identifier string which, when used together with an AssetType, uniquely identifies an asset.

ASSET_SITE_IDENTITY

@ValueClass(java.lang.String.class)
public static final Variety ASSET_SITE_IDENTITY

Asset identifier string typically meant for human eyes. Follows a convention set per site or mandated by the MAM.

DURATION_MS

@ValueClass(java.lang.Integer.class)
public static final Variety DURATION_MS

Duration in milliseconds.

SIZE_BYTES

@ValueClass(java.lang.Long.class)
public static final Variety SIZE_BYTES

File size in bytes

JSON

@ValueClass(java.lang.String.class)
public static final Variety JSON

JSON data. Not for human consumption.

TIMECODED_TEXT

@ValueClass(GenericTable.class)
public static final Variety TIMECODED_TEXT

EXPRESSION

@ValueClass(java.lang.String.class)
public static final Variety EXPRESSION

Typically no value expected, but an expression found in the default value is instead used which operates on the subject as a whole.

PERCENT

@ValueClass(java.lang.Integer.class)
public static final Variety PERCENT

Method Details

values

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