Record Class SmartOrderRouter.RoutingPlan

java.lang.Object

java.lang.Record

com.quantfinlib.execution.SmartOrderRouter.RoutingPlan

Enclosing class:

SmartOrderRouter

public static record SmartOrderRouter.RoutingPlan(List<SmartOrderRouter.RouteLeg> legs, long routedQty, long unroutedQty, double expectedAvgAllInPrice)
extends Record

Constructor Summary

Constructors

Constructor	Description
RoutingPlan(List<SmartOrderRouter.RouteLeg> legs, long routedQty, long unroutedQty, double expectedAvgAllInPrice)	Creates an instance of a RoutingPlan record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
double	expectedAvgAllInPrice()	Returns the value of the expectedAvgAllInPrice record component.
final int	hashCode()	Returns a hash code value for this object.
List<SmartOrderRouter.RouteLeg>	legs()	Returns the value of the legs record component.
long	routedQty()	Returns the value of the routedQty record component.
final String	toString()	Returns a string representation of this record class.
long	unroutedQty()	Returns the value of the unroutedQty record component.

Methods inherited from class java.lang.Object

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

Constructor Details

RoutingPlan

public RoutingPlan(List<SmartOrderRouter.RouteLeg> legs,
 long routedQty,
 long unroutedQty,
 double expectedAvgAllInPrice)

Creates an instance of a RoutingPlan record class.

Parameters:

legs - the value for the legs record component

routedQty - the value for the routedQty record component

unroutedQty - the value for the unroutedQty record component

expectedAvgAllInPrice - the value for the expectedAvgAllInPrice 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.

legs

public List<SmartOrderRouter.RouteLeg> legs()

Returns the value of the legs record component.

Returns:

the value of the legs record component

routedQty

public long routedQty()

Returns the value of the routedQty record component.

Returns:

the value of the routedQty record component

unroutedQty

public long unroutedQty()

Returns the value of the unroutedQty record component.

Returns:

the value of the unroutedQty record component

expectedAvgAllInPrice

public double expectedAvgAllInPrice()

Returns the value of the expectedAvgAllInPrice record component.

Returns:

the value of the expectedAvgAllInPrice record component