Package com.launchdarkly.eventsource

Enum Class ReadyState

java.lang.Object

java.lang.Enum<ReadyState>

com.launchdarkly.eventsource.ReadyState

All Implemented Interfaces:

Serializable, Comparable<ReadyState>, Constable

public enum ReadyState
extends Enum<ReadyState>

Enum values that can be returned by EventSource.getState().

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
CLOSED	The connection has been closed or has failed, and the EventSource will attempt to reconnect.
CONNECTING	The EventSource is attempting to make a connection.
OPEN	The connection is active and the EventSource is listening for events.
RAW	The EventSource's EventSource.start() method has not yet been called.
SHUTDOWN	The connection has been permanently closed and will not reconnect.

Method Summary

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

RAW

public static final ReadyState RAW

The EventSource's EventSource.start() method has not yet been called.

CONNECTING

public static final ReadyState CONNECTING

The EventSource is attempting to make a connection.

OPEN

public static final ReadyState OPEN

The connection is active and the EventSource is listening for events.

CLOSED

public static final ReadyState CLOSED

The connection has been closed or has failed, and the EventSource will attempt to reconnect.

SHUTDOWN

public static final ReadyState SHUTDOWN

The connection has been permanently closed and will not reconnect.

Method Details

values

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