org.snf4j.core.handler

Enum SessionEvent

java.lang.Object

java.lang.Enum<SessionEvent>

org.snf4j.core.handler.SessionEvent

All Implemented Interfaces:

Serializable, Comparable<SessionEvent>

public enum SessionEvent
extends Enum<SessionEvent>

An enum that represents session events related with changes of the session state.

Author:

SNF4J.ORG

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED The session has just been closed.
CREATED The session has just been created.
ENDING The session is about to end.
OPENED The session has just been opened.
READY The session is fully initialized and is ready to send/receive user data.

Method Summary

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

CREATED

public static final SessionEvent CREATED

The session has just been created. After receiving this event the session is still in the SessionState.OPENING state.

Since:

1.0

See Also:

SessionState

OPENED

public static final SessionEvent OPENED

The session has just been opened. After receiving this event the session is in the SessionState.OPEN state.

Since:

1.0

See Also:

SessionState

READY

public static final SessionEvent READY

The session is fully initialized and is ready to send/receive user data.

Since:

1.0

See Also:

SessionState

CLOSED

public static final SessionEvent CLOSED

The session has just been closed. After receiving this event the session is in the SessionState.CLOSING state. This event is only fired if the session was previously in the SessionState.OPEN state. It is always followed by the SESSION_ENDING event.

Since:

1.0

See Also:

SessionState

ENDING

public static final SessionEvent ENDING

The session is about to end. This is the last event fired and after receiving it the session is ready to be garbage collected.

Since:

1.0

Method Detail

values

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

Returns:

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

valueOf

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

type

public EventType type()