io.ably.lib.realtime

Enum ChannelState

java.lang.Object

java.lang.Enum<ChannelState>

io.ably.lib.realtime.ChannelState

All Implemented Interfaces:

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

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
attached
attaching
detached
detaching
failed
initialized
suspended

Method Summary

Modifier and Type	Method and Description
ChannelEvent	getChannelEvent()
static ChannelState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ChannelState[]	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 ChannelState initialized

attaching

public static final ChannelState attaching

attached

public static final ChannelState attached

detaching

public static final ChannelState detaching

detached

public static final ChannelState detached

failed

public static final ChannelState failed

suspended

public static final ChannelState suspended

Method Detail

values

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

Returns:

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

valueOf

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

getChannelEvent

public ChannelEvent getChannelEvent()