Record Class SmartOrderRouter.RouteLeg

java.lang.Object
java.lang.Record
com.quantfinlib.execution.SmartOrderRouter.RouteLeg
Enclosing class:
SmartOrderRouter
public static record SmartOrderRouter.RouteLeg(String venue, double price, long quantity, boolean dark) extends Record
One child order of the routing plan. price is the quoted (pre-fee) price.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RouteLeg(String venue, double price, long quantity, boolean dark)
    Creates an instance of a RouteLeg record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    dark()
    Returns the value of the dark record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    price()
    Returns the value of the price record component.
    long
    quantity()
    Returns the value of the quantity record component.
    final String
    toString()
    Returns a string representation of this record class.
    String
    venue()
    Returns the value of the venue record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RouteLeg

      public RouteLeg(String venue, double price, long quantity, boolean dark)
      Creates an instance of a RouteLeg record class.
      Parameters:
      venue - the value for the venue record component
      price - the value for the price record component
      quantity - the value for the quantity record component
      dark - the value for the dark 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.

    • venue

      public String venue()
      Returns the value of the venue record component.
      Returns:
      the value of the venue record component

    • price

      public double price()
      Returns the value of the price record component.
      Returns:
      the value of the price record component

    • quantity

      public long quantity()
      Returns the value of the quantity record component.
      Returns:
      the value of the quantity record component

    • dark

      public boolean dark()
      Returns the value of the dark record component.
      Returns:
      the value of the dark record component