com.dxfeed.event.misc

Class Configuration

java.lang.Object

com.dxfeed.event.misc.Configuration

All Implemented Interfaces:

EventType<String>, LastingEvent<String>, Serializable

public class Configuration
extends Object
implements LastingEvent<String>, Serializable

Configuration event with application-specific attachment.

Properties

Configuration event has the following properties:

• eventSymbol - symbol of this event;
• version - version;
• attachment - attachment.

Versioning

The version field is used to track changes to the event data. When the version field is enabled (by default), events with a lower version number than the last received will be dropped. This is useful for conflating events, where only the latest version of an event is processed. This is only true when transferring under a TICKER contract and the version field is enabled.

Implementation details

This event is implemented on top of QDS record Configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Configuration() Creates new configuration event with default values.
Configuration(String eventSymbol) Creates new configuration event with the specified event symbol.
Configuration(String eventSymbol, Object attachment) Creates new configuration event with the specified event symbol and attachment.
Configuration(String eventSymbol, Object attachment, int version) Creates new configuration event with the specified event symbol, attachment and version.

Method Summary

Modifier and Type	Method and Description
Object	getAttachment() Returns attachment.
Object	getAttachment(ClassLoader cl) Returns attachment.
String	getEventSymbol() Returns symbol for this event.
long	getEventTime() Returns time when event was created or zero when time is not available.
int	getVersion() Returns the version of this event.
void	setAttachment(Object attachment) Changes attachment.
void	setEventSymbol(String eventSymbol) Changes symbol for this event.
void	setEventTime(long eventTime) Changes event creation time.
void	setVersion(int version) Changes the version of this event.
String	toString() Returns string representation of this configuration event.

Methods inherited from class java.lang.Object

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

Constructor Detail

Configuration

public Configuration()

Creates new configuration event with default values.

Configuration

public Configuration(String eventSymbol)

Creates new configuration event with the specified event symbol.

Parameters:

eventSymbol - event symbol.

Configuration

public Configuration(String eventSymbol,
                     Object attachment)

Creates new configuration event with the specified event symbol and attachment.

Parameters:

eventSymbol - event symbol.

attachment - attachment.

Configuration

public Configuration(String eventSymbol,
                     Object attachment,
                     int version)

Creates new configuration event with the specified event symbol, attachment and version.

Parameters:

eventSymbol - event symbol.

attachment - attachment.

version - version.

Method Detail

getEventSymbol

public String getEventSymbol()

Returns symbol for this event.

Specified by:

getEventSymbol in interface EventType<String>

Returns:

event symbol.

setEventSymbol

public void setEventSymbol(String eventSymbol)

Changes symbol for this event.

Specified by:

setEventSymbol in interface EventType<String>

Parameters:

eventSymbol - event symbol.

getEventTime

public long getEventTime()

Returns time when event was created or zero when time is not available.

This event time is available only when the corresponding DXEndpoint is created with DXENDPOINT_EVENT_TIME_PROPERTY and the data source has embedded event times. This is typically true only for data events that are read from historical tape files and from OnDemandService. Events that are coming from a network connections do not have an embedded event time information and this method will return zero for them, meaning that event was received just now.

Specified by:

getEventTime in interface EventType<String>

Returns:

the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC or zero when time is not available.

setEventTime

public void setEventTime(long eventTime)

Changes event creation time.

Specified by:

setEventTime in interface EventType<String>

Parameters:

eventTime - the difference, measured in milliseconds, between the event creation time and midnight, January 1, 1970 UTC.

getVersion

public int getVersion()

Returns the version of this event.

Returns:

the version of this event. A higher value indicates a more recent update.

See Also:

Versioning section

setVersion

public void setVersion(int version)

Changes the version of this event.

Parameters:

version - the version of this event. A higher value indicates a more recent update.

See Also:

Versioning section

getAttachment

public Object getAttachment()

Returns attachment.

Throws:

RuntimeException - if object cannot be deserialized from its serial form

getAttachment

public Object getAttachment(ClassLoader cl)

Returns attachment.

Parameters:

cl - the ClassLoader that will be used to load classes; null for default

Throws:

RuntimeException - if object cannot be deserialized from its serial form

setAttachment

public void setAttachment(Object attachment)

Changes attachment.

Parameters:

attachment - attachment.

toString

public String toString()

Returns string representation of this configuration event.

Overrides:

toString in class Object