com.dxfeed.event.misc

Class TextConfiguration

java.lang.Object

com.dxfeed.event.misc.TextConfiguration

All Implemented Interfaces:

EventType<String>, LastingEvent<String>, Serializable

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

Configuration event with the text payload.

Properties

TextConfiguration event has the following properties:

• eventSymbol - symbol of this event;
• time - time of this text configuration;
• sequence - sequence of this text configuration;
• version - version;
• text - text payload.

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

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_SEQUENCE Maximum allowed sequence value.

Constructor Summary

Constructors

Constructor and Description
TextConfiguration() Creates a new text configuration event with default values.
TextConfiguration(String eventSymbol) Creates a new text configuration event with the specified event symbol.
TextConfiguration(String eventSymbol, String text) Creates a new text configuration event with the specified event symbol and text.
TextConfiguration(String eventSymbol, String text, int version) Creates a new text configuration event with the specified event symbol, text, and version.

Method Summary

Modifier and Type	Method and Description
String	getEventSymbol() Returns the symbol for this event.
long	getEventTime() Returns time when event was created or zero when time is not available.
int	getSequence() Returns sequence number of this event to distinguish text configuration events that have the same time.
String	getText() Returns the text.
long	getTime() Returns time of this text configuration event.
int	getVersion() Returns the version of this event.
void	setEventSymbol(String eventSymbol) Changes the symbol for this event.
void	setEventTime(long eventTime) Changes event creation time.
void	setSequence(int sequence) Changes sequence number of this text configuration event.
void	setText(String text) Changes the text.
void	setTime(long time) Changes time of this text configuration event.
void	setVersion(int version) Changes the version of this event.
String	toString() Returns a string representation of this text configuration event.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SEQUENCE

public static final int MAX_SEQUENCE

Maximum allowed sequence value.

See Also:

setSequence(int), Constant Field Values

Constructor Detail

TextConfiguration

public TextConfiguration()

Creates a new text configuration event with default values.

TextConfiguration

public TextConfiguration(String eventSymbol)

Creates a new text configuration event with the specified event symbol.

Parameters:

eventSymbol - the event symbol.

TextConfiguration

public TextConfiguration(String eventSymbol,
                         String text)

Creates a new text configuration event with the specified event symbol and text.

Parameters:

eventSymbol - the event symbol.

text - the text.

TextConfiguration

public TextConfiguration(String eventSymbol,
                         String text,
                         int version)

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

Parameters:

eventSymbol - the event symbol.

text - the text.

version - the version.

Method Detail

getEventSymbol

public String getEventSymbol()

Returns the symbol for this event.

Specified by:

getEventSymbol in interface EventType<String>

Returns:

the event symbol.

setEventSymbol

public void setEventSymbol(String eventSymbol)

Changes the symbol for this event.

Specified by:

setEventSymbol in interface EventType<String>

Parameters:

eventSymbol - the 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.

getTime

public long getTime()

Returns time of this text configuration event. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Returns:

time of this text configuration event.

setTime

public void setTime(long time)

Changes time of this text configuration event. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.

Parameters:

time - time of this text configuration event.

getSequence

public int getSequence()

Returns sequence number of this event to distinguish text configuration events that have the same time. This sequence number does not have to be unique and does not need to be sequential. Sequence can range from 0 to MAX_SEQUENCE.

Returns:

sequence of this text configuration event.

setSequence

public void setSequence(int sequence)

Changes sequence number of this text configuration event.

Parameters:

sequence - the sequence.

Throws:

IllegalArgumentException - if the sequence is below zero or above MAX_SEQUENCE.

See Also:

getSequence()

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

getText

public String getText()

Returns the text.

Returns:

the text.

setText

public void setText(String text)

Changes the text.

Parameters:

text - the text.

toString

public String toString()

Returns a string representation of this text configuration event.

Overrides:

toString in class Object

Returns:

a string representation of this text configuration event.