Record Class Trade

java.lang.Object

java.lang.Record

com.wualabs.qtsurfer.engine.core.Trade

Record Components:

id - exchange-assigned trade identifier

instrument - the traded instrument

side - BUY or SELL

amount - base amount traded

price - execution price

feeCurrency - fee currency (may be null if not reported)

fee - fee amount (may be null if not reported)

timestamp - execution timestamp in epoch milliseconds

public record Trade(String id, Instrument instrument, OrderSide side, BigDecimal amount, BigDecimal price, Asset feeCurrency, BigDecimal fee, long timestamp)
extends Record

Canonical trade record for the engine domain (replaces XChange UserTrade in domain code).

Constructor Summary

Constructors

Constructor	Description
Trade(String id, Instrument instrument, OrderSide side, BigDecimal amount, BigDecimal price, Asset feeCurrency, BigDecimal fee, long timestamp)	Creates an instance of a Trade record class.

Method Summary

Modifier and Type	Method	Description
BigDecimal	amount()	Returns the value of the amount record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
BigDecimal	fee()	Returns the value of the fee record component.
Asset	feeCurrency()	Returns the value of the feeCurrency record component.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
Instrument	instrument()	Returns the value of the instrument record component.
BigDecimal	price()	Returns the value of the price record component.
OrderSide	side()	Returns the value of the side record component.
long	timestamp()	Returns the value of the timestamp record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Trade

public Trade(String id,
 Instrument instrument,
 OrderSide side,
 BigDecimal amount,
 BigDecimal price,
 Asset feeCurrency,
 BigDecimal fee,
 long timestamp)

Creates an instance of a Trade record class.

Parameters:

id - the value for the id record component

instrument - the value for the instrument record component

side - the value for the side record component

amount - the value for the amount record component

price - the value for the price record component

feeCurrency - the value for the feeCurrency record component

fee - the value for the fee record component

timestamp - the value for the timestamp record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

instrument

public Instrument instrument()

Returns the value of the instrument record component.

Returns:

the value of the instrument record component

side

public OrderSide side()

Returns the value of the side record component.

Returns:

the value of the side record component

amount

public BigDecimal amount()

Returns the value of the amount record component.

Returns:

the value of the amount record component

price

public BigDecimal price()

Returns the value of the price record component.

Returns:

the value of the price record component

feeCurrency

public Asset feeCurrency()

Returns the value of the feeCurrency record component.

Returns:

the value of the feeCurrency record component

fee

public BigDecimal fee()

Returns the value of the fee record component.

Returns:

the value of the fee record component

timestamp

public long timestamp()

Returns the value of the timestamp record component.

Returns:

the value of the timestamp record component