Record Class CorporateEvents.StockDividend

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEvents.StockDividend
All Implemented Interfaces:
CorporateEvents.Event
Enclosing class:
CorporateEvents
public static record CorporateEvents.StockDividend(long exTimestamp, double rate) extends Record implements CorporateEvents.Event
Stock dividend or bonus issue: rate new shares per share held (0.05 = 5 %).

  • Constructor Summary

    Constructors
    Constructor
    Description
    StockDividend(long exTimestamp, double rate)
    Creates an instance of a StockDividend record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    exTimestamp()
    Returns the value of the exTimestamp record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    rate()
    Returns the value of the rate record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class Object

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

  • Constructor Details

    • StockDividend

      public StockDividend(long exTimestamp, double rate)
      Creates an instance of a StockDividend record class.
      Parameters:
      exTimestamp - the value for the exTimestamp record component
      rate - the value for the rate 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.

    • 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

    • rate

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