Package live.crowdcontrol.cc4j.websocket.data

Enum Class ReportStatus

java.lang.Object

java.lang.Enum<ReportStatus>

live.crowdcontrol.cc4j.websocket.data.ReportStatus

All Implemented Interfaces:

Serializable, Comparable<ReportStatus>, Constable

public enum ReportStatus
extends Enum<ReportStatus>

Dictates the status of effects in the menu.

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
MENU_AVAILABLE	The antithesis of MENU_UNAVAILABLE; indicates that an effect should now be purchasable from the menu.
MENU_HIDDEN	The antithesis of MENU_VISIBLE; indicates that an effect should no longer be visible in the menu.
MENU_UNAVAILABLE	The antithesis of MENU_AVAILABLE; indicates that an effect should no longer be purchasable from the menu.
MENU_VISIBLE	The antithesis of MENU_HIDDEN; indicates that an effect should be visible in the menu.
UNKNOWN	The JSON-specified value could not be decoded.

Method Summary

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

MENU_AVAILABLE

public static final ReportStatus MENU_AVAILABLE

The antithesis of MENU_UNAVAILABLE; indicates that an effect should now be purchasable from the menu. Note that this does not indicate that an effect should be visible; for that see MENU_VISIBLE.

MENU_UNAVAILABLE

public static final ReportStatus MENU_UNAVAILABLE

The antithesis of MENU_AVAILABLE; indicates that an effect should no longer be purchasable from the menu.

MENU_VISIBLE

public static final ReportStatus MENU_VISIBLE

The antithesis of MENU_HIDDEN; indicates that an effect should be visible in the menu. Note that this does not indicate that an effect should be purchasable; for that see MENU_AVAILABLE.

MENU_HIDDEN

public static final ReportStatus MENU_HIDDEN

The antithesis of MENU_VISIBLE; indicates that an effect should no longer be visible in the menu.

UNKNOWN

public static final ReportStatus UNKNOWN

The JSON-specified value could not be decoded.

Method Details

values

public static ReportStatus[] 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 ReportStatus 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 ReportStatus fromValue(@NotNull
 @NotNull String value)

Gets a status from its JSON string value. If a status 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 status.

Returns:

json value

toString

public String toString()

Overrides:

toString in class Enum<ReportStatus>