com.dxfeed.api.osub

Class IndexedEventSubscriptionSymbol<T>

java.lang.Object

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

Type Parameters:

T - the type of the event symbol.

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TimeSeriesSubscriptionSymbol

public class IndexedEventSubscriptionSymbol<T>
extends Object
implements Serializable

Represents subscription to a specific source of indexed events. This is symbol is observed by ObservableSubscriptionChangeListener methods symbolsAdded and symbolsRemoved when subscription to IndexedEvent is defined.

Instances of this class can be used with DXFeedSubscription to specify subscription to a particular source of indexed events. By default, when subscribing to indexed events by their event symbol object, the subscription is performed to all supported sources.

TimeSeriesEvent represents a special subtype of IndexedEvent. There is a more specific TimeSeriesSubscriptionSymbol class that is used when time-series subscription is observed.

Equality and hash codes

Indexed event subscription symbols are compared based on their eventSymbol and source.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
IndexedEventSubscriptionSymbol(T eventSymbol, IndexedEventSource source) Creates indexed event subscription symbol with a specified event symbol and source.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Returns true if other object is IndexedEventSubscriptionSymbol with the same eventSymbol and sourceId.
T	getEventSymbol() Returns event symbol.
IndexedEventSource	getSource() Returns indexed event source.
int	hashCode() Returns hash code.
String	toString() Returns string representation of this indexed event subscription symbol.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexedEventSubscriptionSymbol

public IndexedEventSubscriptionSymbol(T eventSymbol,
                                      IndexedEventSource source)

Creates indexed event subscription symbol with a specified event symbol and source.

Parameters:

eventSymbol - the event symbol.

source - the source.

Throws:

NullPointerException - if eventSymbol or source are null null.

Method Detail

getEventSymbol

public final T getEventSymbol()

Returns event symbol.

Returns:

event symbol.

getSource

public final IndexedEventSource getSource()

Returns indexed event source.

Returns:

indexed event source.

equals

public boolean equals(Object o)

Returns true if other object is IndexedEventSubscriptionSymbol with the same eventSymbol and sourceId.

Overrides:

equals in class Object

Returns:

result of equality check.

hashCode

public int hashCode()

Returns hash code.

Overrides:

hashCode in class Object

Returns:

hash code.

toString

public String toString()

Returns string representation of this indexed event subscription symbol.

Overrides:

toString in class Object

Returns:

string representation of this indexed event subscription symbol.