Package io.ably.lib.realtime

Enum ConnectionState

java.lang.Object

java.lang.Enum<ConnectionState>

io.ably.lib.realtime.ConnectionState

All Implemented Interfaces:

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

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

Connection states. See Ably Realtime API documentation for more details.

Enum Constant Summary

Enum Constants

Enum Constant	Description
closed
closing
connected
connecting
disconnected
failed
initialized
suspended

Method Summary

Modifier and Type	Method	Description
ConnectionEvent	getConnectionEvent()
static ConnectionState	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static ConnectionState[]	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, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

initialized

public static final ConnectionState initialized

connecting

public static final ConnectionState connecting

connected

public static final ConnectionState connected

disconnected

public static final ConnectionState disconnected

suspended

public static final ConnectionState suspended

closing

public static final ConnectionState closing

closed

public static final ConnectionState closed

failed

public static final ConnectionState failed

Method Detail

values

public static ConnectionState[] 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 (ConnectionState c : ConnectionState.values())
    System.out.println(c);

Returns:

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

valueOf

public static ConnectionState 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

getConnectionEvent

public ConnectionEvent getConnectionEvent()