Record Class RankingEngine.ScoredStock

java.lang.Object
java.lang.Record
com.quantfinlib.screener.RankingEngine.ScoredStock
Enclosing class:
RankingEngine
public static record RankingEngine.ScoredStock(StockSnapshot stock, double score) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScoredStock(StockSnapshot stock, double score)
    Creates an instance of a ScoredStock record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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
    score()
    Returns the value of the score record component.
    StockSnapshot
    stock()
    Returns the value of the stock record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • ScoredStock

      public ScoredStock(StockSnapshot stock, double score)
      Creates an instance of a ScoredStock record class.
      Parameters:
      stock - the value for the stock record component
      score - the value for the score 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.

    • stock

      public StockSnapshot stock()
      Returns the value of the stock record component.
      Returns:
      the value of the stock record component

    • score

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