Record Class Fundamentals

java.lang.Object
java.lang.Record
com.quantfinlib.screener.Fundamentals
public record Fundamentals(double marketCap, double peRatio, double pbRatio, double eps, double roe, double dividendYield, double debtToEquity) extends Record
Fundamental data for one instrument. Use Double.NaN for unknown fields; fundamental filters never match on NaN values.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Fundamentals(double marketCap, double peRatio, double pbRatio, double eps, double roe, double dividendYield, double debtToEquity)
    Creates an instance of a Fundamentals record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    debtToEquity()
    Returns the value of the debtToEquity record component.
    double
    dividendYield()
    Returns the value of the dividendYield record component.
    double
    eps()
    Returns the value of the eps 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.
    double
    marketCap()
    Returns the value of the marketCap record component.
    double
    pbRatio()
    Returns the value of the pbRatio record component.
    double
    peRatio()
    Returns the value of the peRatio record component.
    double
    roe()
    Returns the value of the roe record component.
    final String
    toString()
    Returns a string representation of this record class.
    static Fundamentals
    unknown()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Fundamentals

      public Fundamentals(double marketCap, double peRatio, double pbRatio, double eps, double roe, double dividendYield, double debtToEquity)
      Creates an instance of a Fundamentals record class.
      Parameters:
      marketCap - the value for the marketCap record component
      peRatio - the value for the peRatio record component
      pbRatio - the value for the pbRatio record component
      eps - the value for the eps record component
      roe - the value for the roe record component
      dividendYield - the value for the dividendYield record component
      debtToEquity - the value for the debtToEquity record component

  • Method Details

    • unknown

      public static Fundamentals unknown()

    • 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.

    • marketCap

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

    • peRatio

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

    • pbRatio

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

    • eps

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

    • roe

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

    • dividendYield

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

    • debtToEquity

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