com.devexperts.qd.ng

Class AbstractRecordProvider

java.lang.Object

com.devexperts.qd.ng.AbstractRecordProvider

All Implemented Interfaces:

DataProvider, RecordProvider, SubscriptionProvider

Direct Known Subclasses:

CompositeRecordProvider

public abstract class AbstractRecordProvider
extends Object
implements RecordProvider

Bridge class that adapts DataProvider and SubscriptionProvider APIs to RecordProvider API. All you have to do is to implement getMode() and retrieve(RecordSink) methods and optionally override setRecordListener(RecordListener) method, while all the methods of DataProvider and SubscriptionProvider interfaces are already implemented and invoke the above method implementations.

Field Summary

Fields inherited from interface com.devexperts.qd.ng.RecordProvider

VOID

Constructor Summary

Constructors

Constructor and Description
AbstractRecordProvider()

Method Summary

Modifier and Type	Method and Description
abstract RecordMode	getMode() Returns record mode at which the records are provided by retrieve method.
abstract 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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractRecordProvider

public AbstractRecordProvider()

Method Detail

getMode

public abstract RecordMode getMode()

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

Specified by:

getMode in interface RecordProvider

retrieve

public abstract 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.

Specified by:

retrieve in interface RecordProvider

Parameters:

sink - the sink.

Returns:

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

setRecordListener

public 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.

This implementation throws UnsupportedOperationException.

Specified by:

setRecordListener in interface RecordProvider

Parameters:

listener - the listener.

retrieveData

public final 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

Specified by:

retrieveData in interface RecordProvider

retrieveSubscription

public final 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 RecordProvider

Specified by:

retrieveSubscription in interface SubscriptionProvider

setDataListener

public final 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

Specified by:

setDataListener in interface RecordProvider

setSubscriptionListener

public final 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 RecordProvider

Specified by:

setSubscriptionListener in interface SubscriptionProvider