Record Class ScoreDoc

java.lang.Object
java.lang.Record
org.springframework.data.elasticsearch.support.ScoreDoc
public record ScoreDoc(double score, @Nullable Integer doc, @Nullable Integer shardIndex) extends Record
Since:
4.3
Author:
Peter-Josef Meisch

  • Constructor Summary

    Constructors
    Constructor
    Description
    ScoreDoc(double score, @Nullable Integer doc, @Nullable Integer shardIndex)
    Creates an instance of a ScoreDoc record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    @Nullable Integer
    doc()
    Returns the value of the doc 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
    score()
    Returns the value of the score record component.
    @Nullable Integer
    shardIndex()
    Returns the value of the shardIndex 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

    • ScoreDoc

      public ScoreDoc(double score, @Nullable Integer doc, @Nullable Integer shardIndex)
      Creates an instance of a ScoreDoc record class.
      Parameters:
      score - the value for the score record component
      doc - the value for the doc record component
      shardIndex - the value for the shardIndex 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.

    • score

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

    • doc

      public @Nullable Integer doc()
      Returns the value of the doc record component.
      Returns:
      the value of the doc record component

    • shardIndex

      public @Nullable Integer shardIndex()
      Returns the value of the shardIndex record component.
      Returns:
      the value of the shardIndex record component