Record Class CorporateEventPositions.Holding

java.lang.Object
java.lang.Record
com.quantfinlib.data.CorporateEventPositions.Holding
Enclosing class:
CorporateEventPositions
public static record CorporateEventPositions.Holding(String symbol, String isin, double shares, double costBasis) extends Record
One holding of an instrument.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Holding(String symbol, String isin, double shares, double costBasis)
    Creates an instance of a Holding record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    costBasis()
    Returns the value of the costBasis record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    String
    isin()
    Returns the value of the isin record component.
    double
    shares()
    Returns the value of the shares record component.
    String
    symbol()
    Returns the value of the symbol 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

    • Holding

      public Holding(String symbol, String isin, double shares, double costBasis)
      Creates an instance of a Holding record class.
      Parameters:
      symbol - the value for the symbol record component
      isin - the value for the isin record component
      shares - the value for the shares record component
      costBasis - the value for the costBasis 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.

    • symbol

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

    • isin

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

    • shares

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

    • costBasis

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