Package com.btcvelocity.api.queue

Enum Class QueueState

java.lang.Object

java.lang.Enum<QueueState>

com.btcvelocity.api.queue.QueueState

All Implemented Interfaces:

Serializable, Comparable<QueueState>, Constable

public enum QueueState
extends Enum<QueueState>

Represents the operational state of a Queue.

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
ACTIVE	The queue is active and will transfer players to the backend server when it is available.
INACTIVE	The queue is not active and does not process or accept players.
PAUSED	The queue is paused and will not transfer players until it is resumed.

Method Summary

Modifier and Type	Method	Description
static QueueState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static QueueState[]	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

INACTIVE

public static final QueueState INACTIVE

The queue is not active and does not process or accept players.

ACTIVE

public static final QueueState ACTIVE

The queue is active and will transfer players to the backend server when it is available.

PAUSED

public static final QueueState PAUSED

The queue is paused and will not transfer players until it is resumed.

Method Details

values

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