Record Class SpreadExecutionAlgo.Children

java.lang.Object
java.lang.Record
com.quantfinlib.execution.SpreadExecutionAlgo.Children
Enclosing class:
SpreadExecutionAlgo
public static record SpreadExecutionAlgo.Children(long leadQty, long hedgeQty, boolean atRiskCap) extends Record
This interval's child quantities, per leg.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Children(long leadQty, long hedgeQty, boolean atRiskCap)
    Creates an instance of a Children record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    atRiskCap()
    Returns the value of the atRiskCap 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.
    long
    hedgeQty()
    Returns the value of the hedgeQty record component.
    long
    leadQty()
    Returns the value of the leadQty 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

    • Children

      public Children(long leadQty, long hedgeQty, boolean atRiskCap)
      Creates an instance of a Children record class.
      Parameters:
      leadQty - the value for the leadQty record component
      hedgeQty - the value for the hedgeQty record component
      atRiskCap - the value for the atRiskCap 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.

    • leadQty

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

    • hedgeQty

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

    • atRiskCap

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