Record Class OptionsBook.OptionPosition

java.lang.Object
java.lang.Record
com.quantfinlib.hedging.OptionsBook.OptionPosition
Enclosing class:
OptionsBook
public static record OptionsBook.OptionPosition(String label, BlackScholes.OptionType type, double strike, double expiryYears, double quantity, double impliedVol) extends Record
One option position; quantity in option units (contract multiplier applied by caller).

  • Constructor Summary

    Constructors
    Constructor
    Description
    OptionPosition(String label, BlackScholes.OptionType type, double strike, double expiryYears, double quantity, double impliedVol)
    Creates an instance of a OptionPosition 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
    expiryYears()
    Returns the value of the expiryYears record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    impliedVol()
    Returns the value of the impliedVol record component.
    String
    label()
    Returns the value of the label record component.
    double
    quantity()
    Returns the value of the quantity record component.
    double
    strike()
    Returns the value of the strike record component.
    final String
    toString()
    Returns a string representation of this record class.
    BlackScholes.OptionType
    type()
    Returns the value of the type record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OptionPosition

      public OptionPosition(String label, BlackScholes.OptionType type, double strike, double expiryYears, double quantity, double impliedVol)
      Creates an instance of a OptionPosition record class.
      Parameters:
      label - the value for the label record component
      type - the value for the type record component
      strike - the value for the strike record component
      expiryYears - the value for the expiryYears record component
      quantity - the value for the quantity record component
      impliedVol - the value for the impliedVol 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.

    • label

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

    • type

      public BlackScholes.OptionType type()
      Returns the value of the type record component.
      Returns:
      the value of the type record component

    • strike

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

    • expiryYears

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

    • quantity

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

    • impliedVol

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