com.bloomberglp.blpapi

Enum Message.Recap

java.lang.Object

java.lang.Enum<Message.Recap>

com.bloomberglp.blpapi.Message.Recap

All Implemented Interfaces:

Serializable, Comparable<Message.Recap>

Enclosing class:

Message

public static enum Message.Recap
extends Enum<Message.Recap>

Some subscription data messages (messages which originate from events with event type Event.EventType.SUBSCRIPTION_DATA) are recaps, which summarize the overall state of the data associated with a subscription. A solicited recap message is recap intended for a particular consumer who has recently subscribed or re-subscribed to a topic on a service. Services may also emit unsolicited recaps, intended for all consumers, at any time. This enum is used to indicate the recap type for a particular subscription data message.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NONE Normal data tick; not a recap
SOLICITED Generated on request by subscriber
UNSOLICITED Generated at discretion of the service

Method Summary

Methods

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

NONE

public static final Message.Recap NONE

Normal data tick; not a recap

SOLICITED

public static final Message.Recap SOLICITED

Generated on request by subscriber

UNSOLICITED

public static final Message.Recap UNSOLICITED

Generated at discretion of the service

Method Detail

values

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

Returns:

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

valueOf

public static Message.Recap 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