samophis.lavalink.client.entities

Enum State

java.lang.Object

java.lang.Enum<State>

samophis.lavalink.client.entities.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<State>

public enum State
extends java.lang.Enum<State>

Represents the state of a LavaPlayer instance.

Since:

2.0.0

Author:

SamOphis

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED The state LavaPlayer instances get when they send a Voice Update.
DESTROYED The state LavaPlayer instances get when they are destroyed.
NOT_CONNECTED The initial state of all LavaPlayer instances.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_CONNECTED

public static final State NOT_CONNECTED

The initial state of all LavaPlayer instances.

CONNECTED

public static final State CONNECTED

The state LavaPlayer instances get when they send a Voice Update.

DESTROYED

public static final State DESTROYED

The state LavaPlayer instances get when they are destroyed.

Method Detail

values

public static State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (State c : State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static State valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null