Module org.elasticsearch.server
Package org.elasticsearch.search.rank

Record Class RankDoc.RankKey

java.lang.Object
java.lang.Record
org.elasticsearch.search.rank.RankDoc.RankKey
Enclosing class:
RankDoc
public static record RankDoc.RankKey(int doc, int shardIndex) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    RankKey(int doc, int shardIndex)
    Creates an instance of a RankKey record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    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.
    int
    shardIndex()
    Returns the value of the shardIndex 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

    • RankKey

      public RankKey(int doc, int shardIndex)
      Creates an instance of a RankKey record class.
      Parameters:
      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. All components in this record class are compared with '=='.
      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.

    • doc

      public int doc()
      Returns the value of the doc record component.
      Returns:
      the value of the doc record component

    • shardIndex

      public int shardIndex()
      Returns the value of the shardIndex record component.
      Returns:
      the value of the shardIndex record component