Package org.cometd.client

Enum BayeuxClient.State

java.lang.Object

java.lang.Enum<BayeuxClient.State>

org.cometd.client.BayeuxClient.State

All Implemented Interfaces:

Serializable, Comparable<BayeuxClient.State>

Enclosing class:

BayeuxClient

public static enum BayeuxClient.State
extends Enum<BayeuxClient.State>

The states that a BayeuxClient may assume.

Enum Constant Summary

Enum Constants

Enum Constant	Description
CONNECTED	State assumed when this BayeuxClient is connected to the Bayeux server
CONNECTING	State assumed when the connect is being sent for the first time
DISCONNECTED	State assumed before the handshake and when the disconnect is completed
DISCONNECTING	State assumed when the disconnect is being sent
HANDSHAKEN	State assumed when the handshake is received, but before connecting
HANDSHAKING	State assumed when the handshake is being sent
REHANDSHAKING	State assumed when a first handshake failed and the handshake is retried, or when the Bayeux server requests a re-handshake
TERMINATING	State assumed when the disconnect is received but terminal actions must be performed
UNCONNECTED	State assumed after the handshake when the connection is broken

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UNCONNECTED

public static final BayeuxClient.State UNCONNECTED

State assumed after the handshake when the connection is broken

HANDSHAKING

public static final BayeuxClient.State HANDSHAKING

State assumed when the handshake is being sent

REHANDSHAKING

public static final BayeuxClient.State REHANDSHAKING

State assumed when a first handshake failed and the handshake is retried, or when the Bayeux server requests a re-handshake

HANDSHAKEN

public static final BayeuxClient.State HANDSHAKEN

State assumed when the handshake is received, but before connecting

CONNECTING

public static final BayeuxClient.State CONNECTING

State assumed when the connect is being sent for the first time

CONNECTED

public static final BayeuxClient.State CONNECTED

State assumed when this BayeuxClient is connected to the Bayeux server

DISCONNECTING

public static final BayeuxClient.State DISCONNECTING

State assumed when the disconnect is being sent

TERMINATING

public static final BayeuxClient.State TERMINATING

State assumed when the disconnect is received but terminal actions must be performed

DISCONNECTED

public static final BayeuxClient.State DISCONNECTED

State assumed before the handshake and when the disconnect is completed

Method Detail

values

public static BayeuxClient.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 (BayeuxClient.State c : BayeuxClient.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 BayeuxClient.State valueOf(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:

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

NullPointerException - if the argument is null