com.bloomberglp.blpapi

Enum SubscriptionPreprocessMode

java.lang.Object

java.lang.Enum<SubscriptionPreprocessMode>

com.bloomberglp.blpapi.SubscriptionPreprocessMode

All Implemented Interfaces:

Serializable, Comparable<SubscriptionPreprocessMode>

public enum SubscriptionPreprocessMode
extends Enum<SubscriptionPreprocessMode>

Defines how the invalid Subscriptions are managed in the SubscriptionList provided to Session.subscribe(SubscriptionList, Identity, String, SubscriptionPreprocessMode) and Session.resubscribe(SubscriptionList, int, String, SubscriptionPreprocessMode)

Enum Constant Summary

Enum Constants

Enum Constant and Description
FAIL_ON_FIRST_ERROR In this mode, an exception is thrown on the first invalid entry in the SubscriptionList, and the entire batch will be considered failed.
RETURN_INDIVIDUAL_ERRORS In this mode, instead of throwing exceptions, a list of SubscriptionPreprocessError is returned, each representing an error due to an invalid subscription in SubscriptionList.

Method Summary

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

FAIL_ON_FIRST_ERROR

public static final SubscriptionPreprocessMode FAIL_ON_FIRST_ERROR

In this mode, an exception is thrown on the first invalid entry in the SubscriptionList, and the entire batch will be considered failed. Otherwise, all the Subscriptions will move forward and a null list of SubscriptionPreprocessError is returned.

RETURN_INDIVIDUAL_ERRORS

public static final SubscriptionPreprocessMode RETURN_INDIVIDUAL_ERRORS

In this mode, instead of throwing exceptions, a list of SubscriptionPreprocessError is returned, each representing an error due to an invalid subscription in SubscriptionList. The valid subscriptions will move forward.

Method Detail

values

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

Returns:

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

valueOf

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