org.atmosphere.cpr

Enum Action.TYPE

java.lang.Object

java.lang.Enum<Action.TYPE>

org.atmosphere.cpr.Action.TYPE

All Implemented Interfaces:

Serializable, Comparable<Action.TYPE>

Enclosing class:

Action

public static enum Action.TYPE
extends Enum<Action.TYPE>

The action's type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CANCELLED Cancel the current connection/response and close it.
CONTINUE Continue the processing of the request.
CREATED Mark this action as created.
DESTROYED Mark this action as destroyed.
RESUME Resume the underlying connection/response.
SKIP_ATMOSPHEREHANDLER Skip the invocation of AtmosphereHandler, but invoke all AtmosphereInterceptor.
SUSPEND SUSPEND the underlying connection/response.
SUSPEND_MESSAGE Fake suspend for WebSocket Message
TIMEOUT Timeout the underlying connection/response and invoke the AtmosphereResource.resume().

Method Summary

Methods

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

SUSPEND

public static final Action.TYPE SUSPEND

SUSPEND the underlying connection/response. The request will be dispatched to framework/container via AtmosphereHandler.onStateChange(AtmosphereResourceEvent)

RESUME

public static final Action.TYPE RESUME

Resume the underlying connection/response. The request will be dispatched to framework/container via AtmosphereHandler.onStateChange(AtmosphereResourceEvent)

TIMEOUT

public static final Action.TYPE TIMEOUT

Timeout the underlying connection/response and invoke the AtmosphereResource.resume(). The request will be dispatched to framework/container via AtmosphereHandler.onStateChange(AtmosphereResourceEvent)

CANCELLED

public static final Action.TYPE CANCELLED

Cancel the current connection/response and close it. The request will NOT be dispatched to framework/container via AtmosphereHandler

CONTINUE

public static final Action.TYPE CONTINUE

Continue the processing of the request. The request will still be dispatched to framework/container via AtmosphereHandler

CREATED

public static final Action.TYPE CREATED

Mark this action as created. The request will still be dispatched to framework/container via AtmosphereHandler

DESTROYED

public static final Action.TYPE DESTROYED

Mark this action as destroyed. All objects associated with this action will be candidate for being garbage collected.

SUSPEND_MESSAGE

public static final Action.TYPE SUSPEND_MESSAGE

Fake suspend for WebSocket Message

SKIP_ATMOSPHEREHANDLER

public static final Action.TYPE SKIP_ATMOSPHEREHANDLER

Skip the invocation of AtmosphereHandler, but invoke all AtmosphereInterceptor.

Method Detail

values

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

Returns:

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

valueOf

public static Action.TYPE 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