Package rocks.xmpp.core.session

Enum XmppSession.Status

java.lang.Object

java.lang.Enum<XmppSession.Status>

rocks.xmpp.core.session.XmppSession.Status

All Implemented Interfaces:

Serializable, Comparable<XmppSession.Status>

Enclosing class:

XmppSession

public static enum XmppSession.Status
extends Enum<XmppSession.Status>

Represents the session status.

The following chart illustrates the valid status transitions:

 ┌────── INITIAL
 │          │
 │          ▼
 │      CONNECTING ◄────────┐
 │          │               │
 │          ▼               │
 │      CONNECTED ───► DISCONNECTED
 │          │               ▲
 │          ▼               │
 │    AUTHENTICATING        │
 │          │               │
 │          ▼               │
 │    AUTHENTICATED ────────┘
 │          │
 │          ▼
 └─────► CLOSING
            │
            ▼
         CLOSED
 

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTHENTICATED	The session has authenticated.
AUTHENTICATING	The session is currently authenticating with the server.
CLOSED	The session is closed.
CLOSING	The session is closing.
CONNECTED	The session is established with the server, features are negotiated, but we are not yet authenticated.
CONNECTING	The session is currently negotiating features.
DISCONNECTED	The session has been temporarily disconnected by an exception.
INITIAL	The session is in initial state.

Method Summary

Modifier and Type	Method	Description
static XmppSession.Status	valueOf(String name)	Returns the enum constant of this type with the specified name.
static XmppSession.Status[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INITIAL

public static final XmppSession.Status INITIAL

The session is in initial state.

CONNECTING

public static final XmppSession.Status CONNECTING

The session is currently negotiating features.

CONNECTED

public static final XmppSession.Status CONNECTED

The session is established with the server, features are negotiated, but we are not yet authenticated.

AUTHENTICATING

public static final XmppSession.Status AUTHENTICATING

The session is currently authenticating with the server.

AUTHENTICATED

public static final XmppSession.Status AUTHENTICATED

The session has authenticated.

DISCONNECTED

public static final XmppSession.Status DISCONNECTED

The session has been temporarily disconnected by an exception.

CLOSING

public static final XmppSession.Status CLOSING

The session is closing.

CLOSED

public static final XmppSession.Status CLOSED

The session is closed.

Method Detail

values

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

Returns:

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

valueOf

public static XmppSession.Status 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