TradeBase (dxFeed API 3.350)

java.lang.Object
- com.dxfeed.event.market.MarketEvent
- - com.dxfeed.event.market.TradeBase

All Implemented Interfaces:

EventType<String>, LastingEvent<String>, Serializable

Direct Known Subclasses:

Trade, TradeETH
```
public abstract class TradeBase
extends MarketEvent
implements LastingEvent<String>
```
Base class for common fields of Trade and TradeETH events. Trade events represent the most recent information that is available about the last trade on the market at any given moment of time.
Trade event represents last trade information for regular trading hours (RTH) with an official volume and turnover for the whole trading day identified by dayId field.
TradeETH event is defined only for symbols (typically stocks and ETFs) with a designated extended trading hours (ETH, pre market and post market trading sessions). It represents last trade price during ETH and also accumulated volume and turnover during ETH for current trading day.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int MAX_SEQUENCE
Maximum allowed sequence value.

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected StringBuilder`	`fieldsToString(StringBuilder sb)` Appends the field values of this event to a provided `StringBuilder`.
`double`	`getChange()` Returns change of the last trade.
`int`	`getDayId()` Returns identifier of the current trading day.
`double`	`getDayTurnover()` Returns total turnover traded for a day.
`long`	`getDayVolume()` Returns total volume traded for a day as integer number (rounded toward zero).
`double`	`getDayVolumeAsDouble()` Returns total volume traded for a day as floating number with fractions.
`char`	`getExchangeCode()` Returns exchange code of the last trade.
`protected int`	`getFlags()` Returns implementation-specific flags.
`double`	`getPrice()` Returns price of the last trade.
`int`	`getSequence()` Returns sequence number of the last trade to distinguish trades that have the same `time`.
`long`	`getSize()` Returns size of the last trade as integer number (rounded toward zero).
`double`	`getSizeAsDouble()` Returns size of the last trade as floating number with fractions.
`Direction`	`getTickDirection()` Returns tick direction of the last trade.
`long`	`getTime()` Returns time of the last trade.
`int`	`getTimeNanoPart()` Returns microseconds and nanoseconds time part of the last trade.
`long`	`getTimeNanos()` Returns time of the last trade in nanoseconds.
`long`	`getTimeSequence()` Returns time and sequence of last trade packaged into single long value.
`long`	`getTradeId()` Returns trade ID for events containing trade-related action (executions, corrections, or cancellations).
`boolean`	`isExtendedTradingHours()` Returns whether last trade was in extended trading hours.
`void`	`setChange(double change)` Changes change of the last trade.
`void`	`setDayId(int dayId)` Changes identifier of the current trading day.
`void`	`setDayTurnover(double dayTurnover)` Changes total turnover traded for a day.
`void`	`setDayVolume(long dayVolume)` Changes total volume traded for a day as integer number (rounded toward zero).
`void`	`setDayVolumeAsDouble(double dayVolume)` Changes total volume traded for a day as floating number with fractions.
`void`	`setExchangeCode(char exchangeCode)` Changes exchange code of the last trade.
`void`	`setExtendedTradingHours(boolean extendedTradingHours)` Changes whether last trade was in extended trading hours.
`protected void`	`setFlags(int flags)` Changes implementation-specific flags.
`void`	`setPrice(double price)` Changes price of the last trade.
`void`	`setSequence(int sequence)` Changes `sequence number` of the last trade.
`void`	`setSize(long size)` Changes size of the last trade as integer number (rounded toward zero).
`void`	`setSizeAsDouble(double size)` Changes size of the last trade as floating number with fractions.
`void`	`setTickDirection(Direction direction)` Changes tick direction of the last trade.
`void`	`setTime(long time)` Changes time of the last trade.
`void`	`setTimeNanoPart(int timeNanoPart)` Changes microseconds and nanoseconds time part of the last trade.
`void`	`setTimeNanos(long timeNanos)` Changes time of the last trade.
`void`	`setTimeSequence(long timeSequence)` Changes time and sequence of last trade.
`void`	`setTradeId(long tradeId)` Changes trade ID.
`String`	`toString()` Returns string representation of this trade event.

Methods inherited from class com.dxfeed.event.market.MarketEvent
getEventSymbol, getEventTime, setEventSymbol, setEventTime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.dxfeed.event.EventType
getEventSymbol, getEventTime, setEventSymbol, setEventTime

- Field Detail
  - MAX_SEQUENCE
```
public static final int MAX_SEQUENCE
```
    Maximum allowed sequence value.
    
    See Also:
    
    setSequence(int), Constant Field Values
- Method Detail
  - getTimeSequence
```
public long getTimeSequence()
```
    Returns time and sequence of last trade packaged into single long value.
    
    Returns:
    
    time and sequence of last trade.
  - setTimeSequence
```
public void setTimeSequence(long timeSequence)
```
    Changes time and sequence of last trade. Do not use this method directly. Change time and/or sequence.
    
    Parameters:
    
    timeSequence - the time and sequence.
    
    See Also:
    
    getTimeSequence()
  - getTime
```
public long getTime()
```
    Returns time of the last trade. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.
    
    Returns:
    
    time of the last trade.
  - setTime
```
public void setTime(long time)
```
    Changes time of the last trade. Time is measured in milliseconds between the current time and midnight, January 1, 1970 UTC.
    
    Parameters:
    
    time - time of the last trade.
  - getTimeNanos
```
public long getTimeNanos()
```
    Returns time of the last trade in nanoseconds. Time is measured in nanoseconds between the current time and midnight, January 1, 1970 UTC.
    
    Returns:
    
    time of the last trade in nanoseconds.
  - setTimeNanos
```
public void setTimeNanos(long timeNanos)
```
    Changes time of the last trade. Time is measured in nanoseconds between the current time and midnight, January 1, 1970 UTC.
    
    Parameters:
    
    timeNanos - time of the last trade in nanoseconds.
  - setTimeNanoPart
```
public void setTimeNanoPart(int timeNanoPart)
```
    Changes microseconds and nanoseconds time part of the last trade.
    
    Parameters:
    
    timeNanoPart - microseconds and nanoseconds time part of the last trade.
  - getTimeNanoPart
```
public int getTimeNanoPart()
```
    Returns microseconds and nanoseconds time part of the last trade.
    
    Returns:
    
    microseconds and nanoseconds time part of the last trade.
  - getSequence
```
public int getSequence()
```
    Returns sequence number of the last trade to distinguish trades 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 the last trade.
  - setSequence
```
public void setSequence(int sequence)
```
    Changes sequence number of the last trade.
    
    Parameters:
    
    sequence - the sequence.
    
    Throws:
    
    IllegalArgumentException - if sequence is below zero or above MAX_SEQUENCE.
    
    See Also:
    
    getSequence()
  - getExchangeCode
```
public char getExchangeCode()
```
    Returns exchange code of the last trade.
    
    Returns:
    
    exchange code of the last trade.
  - setExchangeCode
```
public void setExchangeCode(char exchangeCode)
```
    Changes exchange code of the last trade.
    
    Parameters:
    
    exchangeCode - exchange code of the last trade.
  - getTradeId
```
public long getTradeId()
```
    Returns trade ID for events containing trade-related action (executions, corrections, or cancellations).
    
    Returns:
    
    trade ID or 0 if not available.
  - setTradeId
```
public void setTradeId(long tradeId)
```
    Changes trade ID.
    
    Parameters:
    
    tradeId - trade ID.
  - getPrice
```
public double getPrice()
```
    Returns price of the last trade.
    
    Returns:
    
    price of the last trade.
  - setPrice
```
public void setPrice(double price)
```
    Changes price of the last trade.
    
    Parameters:
    
    price - price of the last trade.
  - getSize
```
public long getSize()
```
    Returns size of the last trade as integer number (rounded toward zero).
    
    Returns:
    
    size of the last trade as integer number (rounded toward zero).
  - setSize
```
public void setSize(long size)
```
    Changes size of the last trade as integer number (rounded toward zero).
    
    Parameters:
    
    size - size of the last trade as integer number (rounded toward zero).
  - getSizeAsDouble
```
public double getSizeAsDouble()
```
    Returns size of the last trade as floating number with fractions.
    
    Returns:
    
    size of the last trade as floating number with fractions.
  - setSizeAsDouble
```
public void setSizeAsDouble(double size)
```
    Changes size of the last trade as floating number with fractions.
    
    Parameters:
    
    size - size of the last trade as floating number with fractions.
  - getDayId
```
public int getDayId()
```
    Returns identifier of the current trading day. Identifier of the day is the number of days passed since January 1, 1970.
    
    Returns:
    
    identifier of the current trading day.
  - setDayId
```
public void setDayId(int dayId)
```
    Changes identifier of the current trading day. Identifier of the day is the number of days passed since January 1, 1970.
    
    Parameters:
    
    dayId - identifier of the current trading day.
  - getDayVolume
```
public long getDayVolume()
```
    Returns total volume traded for a day as integer number (rounded toward zero).
    
    Returns:
    
    total volume traded for a day as integer number (rounded toward zero).
  - setDayVolume
```
public void setDayVolume(long dayVolume)
```
    Changes total volume traded for a day as integer number (rounded toward zero).
    
    Parameters:
    
    dayVolume - total volume traded for a day as integer number (rounded toward zero).
  - getDayVolumeAsDouble
```
public double getDayVolumeAsDouble()
```
    Returns total volume traded for a day as floating number with fractions.
    
    Returns:
    
    total volume traded for a day as floating number with fractions.
  - setDayVolumeAsDouble
```
public void setDayVolumeAsDouble(double dayVolume)
```
    Changes total volume traded for a day as floating number with fractions.
    
    Parameters:
    
    dayVolume - total volume traded for a day as floating number with fractions.
  - getDayTurnover
```
public double getDayTurnover()
```
    Returns total turnover traded for a day. Day VWAP can be computed with getDayTurnover() / getDayVolume().
    
    Returns:
    
    total turnover traded for a day.
  - setDayTurnover
```
public void setDayTurnover(double dayTurnover)
```
    Changes total turnover traded for a day.
    
    Parameters:
    
    dayTurnover - total turnover traded for a day.
  - getTickDirection
```
public Direction getTickDirection()
```
    Returns tick direction of the last trade.
    
    Returns:
    
    tick direction of the last trade.
  - setTickDirection
```
public void setTickDirection(Direction direction)
```
    Changes tick direction of the last trade.
    
    Parameters:
    
    direction - tick direction of the last trade.
  - isExtendedTradingHours
```
public boolean isExtendedTradingHours()
```
    Returns whether last trade was in extended trading hours.
    
    Returns:
    
    true if last trade was in extended trading hours.
  - setExtendedTradingHours
```
public void setExtendedTradingHours(boolean extendedTradingHours)
```
    Changes whether last trade was in extended trading hours.
    
    Parameters:
    
    extendedTradingHours - true if last trade was in extended trading hours.
  - getChange
```
public double getChange()
```
    Returns change of the last trade.
    
    Returns:
    
    change of the last trade.
  - setChange
```
public void setChange(double change)
```
    Changes change of the last trade.
    
    Parameters:
    
    change - price of the last trade.
  - toString
```
public String toString()
```
    Returns string representation of this trade event.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    string representation of this trade event.
  - fieldsToString
```
protected StringBuilder fieldsToString(StringBuilder sb)
```
    Appends the field values of this event to a provided StringBuilder. This method is responsible for converting each field to a string representation and appending it to the StringBuilder passed as a parameter.
    Inheritor classes are encouraged to override this method to add additional fields specific to their implementations. When overriding, the subclass should first call super.fieldsToString(sb) before appending its own fields to maintain the structure of the data representation.
    
    Parameters:
    
    sb - instance to which field values are appended.
    
    Returns:
    
    instance passed in, after field values have been appended.
  - getFlags
```
protected int getFlags()
```
    Returns implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.
    
    Returns:
    
    flags.
  - setFlags
```
protected void setFlags(int flags)
```
    Changes implementation-specific flags. Do not use this method directly. It may be removed or changed in the future versions.
    
    Parameters:
    
    flags - flags.

Class TradeBase

Field Summary

Method Summary

Methods inherited from class com.dxfeed.event.market.MarketEvent

Methods inherited from class java.lang.Object

Methods inherited from interface com.dxfeed.event.EventType

Field Detail

MAX_SEQUENCE

Method Detail

getTimeSequence

setTimeSequence

getTime

setTime

getTimeNanos

setTimeNanos

setTimeNanoPart

getTimeNanoPart

getSequence

setSequence

getExchangeCode

setExchangeCode

getTradeId

setTradeId

getPrice

setPrice

getSize

setSize

getSizeAsDouble

setSizeAsDouble

getDayId

setDayId

getDayVolume

setDayVolume

getDayVolumeAsDouble

setDayVolumeAsDouble

getDayTurnover

setDayTurnover

getTickDirection

setTickDirection

isExtendedTradingHours

setExtendedTradingHours

getChange

setChange

toString

fieldsToString

getFlags

setFlags