Package live.crowdcontrol.cc4j.websocket.data

Enum Class IdentifierType

java.lang.Object

java.lang.Enum<IdentifierType>

live.crowdcontrol.cc4j.websocket.data.IdentifierType

All Implemented Interfaces:

Serializable, Comparable<IdentifierType>, Constable

public enum IdentifierType
extends Enum<IdentifierType>

Identifies ways in which groups of effects can be referenced.

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
CATEGORY	References categories of effects, which are user-facing collections of effects.
EFFECT	References individual effects.
GROUP	References groups of effects, which are exclusively developer-facing collections to effects.
UNKNOWN	The JSON-specified value could not be decoded.

Method Summary

Modifier and Type	Method	Description
static @NotNull IdentifierType	fromValue(@NotNull String value)	Gets an identifier from its JSON string value.
@NotNull String	getValue()	Gets the encoded string value of this identifier.
String	toString()
static IdentifierType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static IdentifierType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EFFECT

public static final IdentifierType EFFECT

References individual effects.

CATEGORY

public static final IdentifierType CATEGORY

References categories of effects, which are user-facing collections of effects.

GROUP

public static final IdentifierType GROUP

References groups of effects, which are exclusively developer-facing collections to effects.

UNKNOWN

public static final IdentifierType UNKNOWN

The JSON-specified value could not be decoded.

Method Details

values

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

fromValue

@NotNull
public static @NotNull IdentifierType fromValue(@NotNull
 @NotNull String value)

Gets an identifier from its JSON string value. If an identifier by the provided name could not be found, returns UNKNOWN.

Parameters:

value - JSON string value

Returns:

result status value

getValue

@NotNull
public @NotNull String getValue()

Gets the encoded string value of this identifier.

Returns:

json value

toString

public String toString()

Overrides:

toString in class Enum<IdentifierType>