Record Class CorporateEvents.SpinOff

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEvents.SpinOff
Record Components:
childSymbol - symbol of the new instrument
childIsin - ISIN of the new instrument
ratio - child shares distributed per parent share
childPrice - reference price of the child (first regular-way close)
All Implemented Interfaces:
CorporateEvents.Event
Enclosing class:
CorporateEvents
public static record CorporateEvents.SpinOff(long exTimestamp, String childSymbol, String childIsin, double ratio, double childPrice) extends Record implements CorporateEvents.Event
Spin-off of a new instrument.

  • Constructor Details

    • SpinOff

      public SpinOff(long exTimestamp, String childSymbol, String childIsin, double ratio, double childPrice)
      Creates an instance of a SpinOff record class.
      Parameters:
      exTimestamp - the value for the exTimestamp record component
      childSymbol - the value for the childSymbol record component
      childIsin - the value for the childIsin record component
      ratio - the value for the ratio record component
      childPrice - the value for the childPrice 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.

    • exTimestamp

      public long exTimestamp()
      Returns the value of the exTimestamp record component.
      Specified by:
      exTimestamp in interface CorporateEvents.Event
      Returns:
      the value of the exTimestamp record component

    • childSymbol

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

    • childIsin

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

    • ratio

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

    • childPrice

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