com.dxfeed.api.osub

Class TimeSeriesSubscriptionSymbol<T>

java.lang.Object

com.dxfeed.api.osub.IndexedEventSubscriptionSymbol<T>

com.dxfeed.api.osub.TimeSeriesSubscriptionSymbol<T>

Type Parameters:

T - the type of the event symbol.

All Implemented Interfaces:

FilteredSubscriptionSymbol, Serializable

public class TimeSeriesSubscriptionSymbol<T>
extends IndexedEventSubscriptionSymbol<T>
implements FilteredSubscriptionSymbol

Represents subscription to time-series of events. This is symbol is observed by ObservableSubscriptionChangeListener methods symbolsAdded and symbolsRemoved when time-series subscription is created via DXFeedTimeSeriesSubscription class.

Instances of this class can be used with DXFeedSubscription to specify subscription for time series events from a specific time. By default, subscribing to time-series events by their event symbol object, the subscription is performed to a stream of new events as they happen only.

TimeSeriesEvent represents a special subtype of IndexedEvent. The source identifier of a time-series event is always zero and thus getSource method for time-series subscription symbol always returns DEFAULT.

Equality and hash codes

This is a FilteredSubscriptionSymbol. Time-series subscription symbols are compared based on their eventSymbol only. It means, that a set of time-series subscription symbols can contain at most one time-series subscription for each event symbol.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TimeSeriesSubscriptionSymbol(T eventSymbol, long fromTime) Creates time-series subscription symbol with a specified event symbol and subscription time.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if other object is TimeSeriesSubscriptionSymbol with the same eventSymbol.
long	getFromTime() Returns subscription time.
int	hashCode() Returns eventSymbol hash code.
String	toString() Returns string representation of this time-series subscription symbol.

Methods inherited from class com.dxfeed.api.osub.IndexedEventSubscriptionSymbol

getEventSymbol, getSource

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TimeSeriesSubscriptionSymbol

public TimeSeriesSubscriptionSymbol(T eventSymbol,
                                    long fromTime)

Creates time-series subscription symbol with a specified event symbol and subscription time.

Parameters:

eventSymbol - the event symbol.

fromTime - the subscription time.

Throws:

NullPointerException - if eventSymbol is null.

Method Detail

getFromTime

public final long getFromTime()

Returns subscription time.

Returns:

subscription time.

equals

public boolean equals(Object o)

Returns true if other object is TimeSeriesSubscriptionSymbol with the same eventSymbol.

Overrides:

equals in class IndexedEventSubscriptionSymbol<T>

Returns:

result of equality check.

hashCode

public int hashCode()

Returns eventSymbol hash code.

Overrides:

hashCode in class IndexedEventSubscriptionSymbol<T>

Returns:

eventSymbol hash code.

toString

public String toString()

Returns string representation of this time-series subscription symbol.

Overrides:

toString in class IndexedEventSubscriptionSymbol<T>

Returns:

string representation of this time-series subscription symbol.