Package dev.arbjerg.lavalink.api

Enum ISocketContext.State

java.lang.Object

java.lang.Enum<ISocketContext.State>

dev.arbjerg.lavalink.api.ISocketContext.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ISocketContext.State>, java.lang.constant.Constable

Enclosing interface:

ISocketContext

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

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

java.lang.Enum.EnumDesc<E extends java.lang.Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DESTROYED	The WebSocket has closed and this context will never be used again
OPEN	The context has an open WebSocket
RESUMABLE	The context does not have an open WebSocket, but can later be resumed

Method Summary

Modifier and Type	Method	Description
static ISocketContext.State	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ISocketContext.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

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

OPEN

public static final ISocketContext.State OPEN

The context has an open WebSocket

RESUMABLE

public static final ISocketContext.State RESUMABLE

The context does not have an open WebSocket, but can later be resumed

DESTROYED

public static final ISocketContext.State DESTROYED

The WebSocket has closed and this context will never be used again

Method Details

values

public static ISocketContext.State[] values()

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

Returns:

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

valueOf

public static ISocketContext.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