Record Class CorporateEvents.Dividend

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEvents.Dividend
All Implemented Interfaces:
CorporateEvents.Event
Enclosing class:
CorporateEvents
public static record CorporateEvents.Dividend(long exTimestamp, double amount, CorporateEvents.DividendKind kind) extends Record implements CorporateEvents.Event
Cash dividend tagged regular or special.

  • Constructor Details

    • Dividend

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

    • amount

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

    • kind

      public CorporateEvents.DividendKind kind()
      Returns the value of the kind record component.
      Returns:
      the value of the kind record component