Package studio.magemonkey.fabled.cast

Enum Class PreviewType

java.lang.Object

java.lang.Enum<PreviewType>

studio.magemonkey.fabled.cast.PreviewType

All Implemented Interfaces:

Serializable, Comparable<PreviewType>, Constable

public enum PreviewType
extends Enum<PreviewType>

The type of indicator display to use

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
DIM_2
DIM_3
NONE

Method Summary

Modifier and Type	Method	Description
static PreviewType	getByKey(String key)	Gets the indicator type by key
String	getKey()
static PreviewType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static PreviewType[]	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

DIM_3

public static final PreviewType DIM_3

DIM_2

public static final PreviewType DIM_2

NONE

public static final PreviewType NONE

Method Details

values

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

getKey

public String getKey()

getByKey

public static PreviewType getByKey(String key)

Gets the indicator type by key

Parameters:

key - key

Returns:

indicator type