com.solacesystems.jcsmp

Enum CacheLiveDataAction

java.lang.Object

java.lang.Enum<CacheLiveDataAction>

com.solacesystems.jcsmp.CacheLiveDataAction

All Implemented Interfaces:

Serializable, Comparable<CacheLiveDataAction>

public enum CacheLiveDataAction
extends Enum<CacheLiveDataAction>

The live data action dictates the disposition of live data received while the cache request is outstanding to the solCache. One of the live data actions must be chosen.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FLOW_THRU Pass through to the application live data that arrives that matches the topic while a cache request is outstanding.
FULFILL Consider the cache request finished when live data arrives that matches the topic.
QUEUE Queue live data that arrives that matches the topic until the cache request completes.

Method Summary

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

FULFILL

public static final CacheLiveDataAction FULFILL

Consider the cache request finished when live data arrives that matches the topic. Note that wildcard cache requests must always be FLOW_THRU.

QUEUE

public static final CacheLiveDataAction QUEUE

Queue live data that arrives that matches the topic until the cache request completes. Note that wildcard cache requests must always be FLOW_THRU.

FLOW_THRU

public static final CacheLiveDataAction FLOW_THRU

Pass through to the application live data that arrives that matches the topic while a cache request is outstanding. Note that wildcard cache requests must always be FLOW_THRU.

Method Detail

values

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

Returns:

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

valueOf

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