Module org.elasticsearch.server
Package org.elasticsearch.synonyms

Record Class PagedResult<T extends Writeable>

java.lang.Object
java.lang.Record
org.elasticsearch.synonyms.PagedResult<T>
Type Parameters:
T - type of results
Record Components:
totalResults - total number of results
pageResults - results for current page
public record PagedResult<T extends Writeable>(long totalResults, T extends Writeable[] pageResults) extends Record
A paged result that includes total number of results and the results for the current page

  • Constructor Summary

    Constructors
    Constructor
    Description
    PagedResult(long totalResults, T[] pageResults)
    Creates an instance of a PagedResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    int
    hashCode()
    Returns a hash code value for this object.
    T[]
    pageResults()
    Returns the value of the pageResults record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalResults()
    Returns the value of the totalResults record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • PagedResult

      public PagedResult(long totalResults, T[] pageResults)
      Creates an instance of a PagedResult record class.
      Parameters:
      totalResults - the value for the totalResults record component
      pageResults - the value for the pageResults record component

  • Method Details

    • equals

      public 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 '=='.
      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.

    • hashCode

      public 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

    • 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

    • totalResults

      public long totalResults()
      Returns the value of the totalResults record component.
      Returns:
      the value of the totalResults record component

    • pageResults

      public T[] pageResults()
      Returns the value of the pageResults record component.
      Returns:
      the value of the pageResults record component