Record Class CrbAutoHedger.HedgeOrder

java.lang.Object
java.lang.Record
com.quantfinlib.crb.CrbAutoHedger.HedgeOrder
Enclosing class:
CrbAutoHedger
public static record CrbAutoHedger.HedgeOrder(int instrument, double notional) extends Record
One instrument's hedge instruction.

  • Constructor Summary

    Constructors
    Constructor
    Description
    HedgeOrder(int instrument, double notional)
    Creates an instance of a HedgeOrder record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    int
    instrument()
    Returns the value of the instrument record component.
    double
    notional()
    Returns the value of the notional 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

    • HedgeOrder

      public HedgeOrder(int instrument, double notional)
      Creates an instance of a HedgeOrder record class.
      Parameters:
      instrument - the value for the instrument record component
      notional - the value for the notional 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.

    • instrument

      public int instrument()
      Returns the value of the instrument record component.
      Returns:
      the value of the instrument record component

    • notional

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