Record Class OrderPlacementPolicy.Placement

java.lang.Object
java.lang.Record
com.quantfinlib.execution.OrderPlacementPolicy.Placement
Enclosing class:
OrderPlacementPolicy
public static record OrderPlacementPolicy.Placement(boolean post, double expectedPostCost, double crossCost) extends Record
The decision plus the arithmetic that made it.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Placement(boolean post, double expectedPostCost, double crossCost)
    Creates an instance of a Placement record class.

  • Method Summary

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

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Placement

      public Placement(boolean post, double expectedPostCost, double crossCost)
      Creates an instance of a Placement record class.
      Parameters:
      post - the value for the post record component
      expectedPostCost - the value for the expectedPostCost record component
      crossCost - the value for the crossCost 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. All components in this record class 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.

    • post

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

    • expectedPostCost

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

    • crossCost

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