Record Class CorporateEvents.CashStockMerger

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEvents.CashStockMerger
Record Components:
acquirerSymbol - acquirer symbol
acquirerIsin - acquirer ISIN
cashPerShare - cash paid per target share under a cash election
stockPerShare - acquirer shares per target share under a stock election
maxCashFraction - fraction of all target shares the deal will pay in cash; if cash elections exceed it, cash electors are prorated
acquirerPrice - acquirer price used for cash in lieu of fractions
All Implemented Interfaces:
CorporateEvents.Event
Enclosing class:
CorporateEvents
public static record CorporateEvents.CashStockMerger(long exTimestamp, String acquirerSymbol, String acquirerIsin, double cashPerShare, double stockPerShare, double maxCashFraction, double acquirerPrice) extends Record implements CorporateEvents.Event
Cash-and-stock merger with holder election and proration.

  • Constructor Details

    • CashStockMerger

      public CashStockMerger(long exTimestamp, String acquirerSymbol, String acquirerIsin, double cashPerShare, double stockPerShare, double maxCashFraction, double acquirerPrice)
      Creates an instance of a CashStockMerger record class.
      Parameters:
      exTimestamp - the value for the exTimestamp record component
      acquirerSymbol - the value for the acquirerSymbol record component
      acquirerIsin - the value for the acquirerIsin record component
      cashPerShare - the value for the cashPerShare record component
      stockPerShare - the value for the stockPerShare record component
      maxCashFraction - the value for the maxCashFraction record component
      acquirerPrice - the value for the acquirerPrice 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

    • acquirerSymbol

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

    • acquirerIsin

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

    • cashPerShare

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

    • stockPerShare

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

    • maxCashFraction

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

    • acquirerPrice

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