Record Class CorporateEventPositions.Outcome

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEventPositions.Outcome
Enclosing class:
CorporateEventPositions
public static record CorporateEventPositions.Outcome(List<CorporateEventPositions.Holding> holdings, double cash) extends Record
Result of applying an event: the resulting holdings (the original instrument first, possibly with zero shares) and cash received.

  • Constructor Details

    • Outcome

      public Outcome(List<CorporateEventPositions.Holding> holdings, double cash)
      Creates an instance of a Outcome record class.
      Parameters:
      holdings - the value for the holdings record component
      cash - the value for the cash 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.

    • holdings

      public List<CorporateEventPositions.Holding> holdings()
      Returns the value of the holdings record component.
      Returns:
      the value of the holdings record component

    • cash

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