org.atmosphere.cpr

Enum BroadcastFilter.BroadcastAction.ACTION

java.lang.Object

java.lang.Enum<BroadcastFilter.BroadcastAction.ACTION>

org.atmosphere.cpr.BroadcastFilter.BroadcastAction.ACTION

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<BroadcastFilter.BroadcastAction.ACTION>

Enclosing class:

BroadcastFilter.BroadcastAction

public static enum BroadcastFilter.BroadcastAction.ACTION
extends java.lang.Enum<BroadcastFilter.BroadcastAction.ACTION>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORT Return ABORT to stop invoking any remaining BroadcastFilter and to discard the message for being delivered to AtmosphereHandler.onStateChange(AtmosphereResourceEvent).
CONTINUE Return CONTINUE to invoke all remaining BroadcastFilters.
SKIP Return SKIP to stop invoking any remaining BroadcastFilter, but deliver the last transformed message.

Method Summary

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

CONTINUE

public static final BroadcastFilter.BroadcastAction.ACTION CONTINUE

Return CONTINUE to invoke all remaining BroadcastFilters.

ABORT

public static final BroadcastFilter.BroadcastAction.ACTION ABORT

Return ABORT to stop invoking any remaining BroadcastFilter and to discard the message for being delivered to AtmosphereHandler.onStateChange(AtmosphereResourceEvent).

SKIP

public static final BroadcastFilter.BroadcastAction.ACTION SKIP

Return SKIP to stop invoking any remaining BroadcastFilter, but deliver the last transformed message.

Method Detail

values

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

Returns:

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

valueOf

public static BroadcastFilter.BroadcastAction.ACTION 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