com.devexperts.qd.ng

Interface RecordProvider

All Superinterfaces:

DataProvider, SubscriptionProvider

All Known Subinterfaces:

QDAgent

All Known Implementing Classes:

AbstractRecordProvider, CompositeRecordProvider, RecordBuffer

public interface RecordProvider
extends DataProvider, SubscriptionProvider

An object that can notify about new records and let retrieve them. This interface is replacing legacy interfaces DataProvider and SubscriptionProvider.

Field Summary

Fields

Modifier and Type	Field and Description
static RecordProvider	VOID

Method Summary

Modifier and Type	Method and Description
RecordMode	getMode() Returns record mode at which the records are provided by retrieve method.
boolean	retrieve(RecordSink sink) Retrieves accumulated records into the specified record sink while the sink has capacity.
boolean	retrieveData(DataVisitor visitor) Deprecated. Use retrieve(RecordSink)
boolean	retrieveSubscription(SubscriptionVisitor visitor) Deprecated. Use retrieve(RecordSink)
void	setDataListener(DataListener listener) Deprecated. Use setRecordListener(RecordListener)
void	setRecordListener(RecordListener listener) Sets new record listener to receive notifications about available records.
void	setSubscriptionListener(SubscriptionListener listener) Deprecated. Use setRecordListener(RecordListener)

Field Detail

VOID

static final RecordProvider VOID

Method Detail

getMode

RecordMode getMode()

Returns record mode at which the records are provided by retrieve method.

retrieve

boolean retrieve(RecordSink sink)

Retrieves accumulated records into the specified record sink while the sink has capacity. Returns true if some records still remains in the provider or false if all accumulated records were retrieved.

Parameters:

sink - the sink.

Returns:

true if some records still remains in the provider, false if all accumulated records were retrieved.

setRecordListener

void setRecordListener(RecordListener listener)

Sets new record listener to receive notifications about available records. Only one listener at a time is supported; the former listener is discarded. Use null to set empty data listener (no notifications).

NOTE: if there are accumulated data available, then specified listener will be notified by this method.

Parameters:

listener - the listener.

retrieveData

boolean retrieveData(DataVisitor visitor)

Deprecated. Use retrieve(RecordSink)

Retrieves accumulated data into specified data visitor. Returns true if some data still remains in the provider or false if all accumulated data were retrieved.

Specified by:

retrieveData in interface DataProvider

retrieveSubscription

boolean retrieveSubscription(SubscriptionVisitor visitor)

Deprecated. Use retrieve(RecordSink)

Retrieves accumulated subscription into specified subscription visitor. Returns true if some subscription still remains in the provider or false if all accumulated subscription were retrieved.

Specified by:

retrieveSubscription in interface SubscriptionProvider

setDataListener

void setDataListener(DataListener listener)

Deprecated. Use setRecordListener(RecordListener)

Sets new data listener to receive notifications about data. Only one listener at a time is supported; the former listener is discarded. Use null to set empty data listener (no notifications).

NOTE: if there is accumulated data available, then specified listener will be notified by this method.

Specified by:

setDataListener in interface DataProvider

setSubscriptionListener

void setSubscriptionListener(SubscriptionListener listener)

Deprecated. Use setRecordListener(RecordListener)

Sets new subscription listener to receive notifications about subscription. Only one listener at a time is supported; the former listener is discarded. Use null to set empty subscription listener (no notifications).

NOTE: if there is accumulated subscription available, then specified listener will be notified by this method.

Specified by:

setSubscriptionListener in interface SubscriptionProvider