Record Class PageResult<T>

java.lang.Object
java.lang.Record
com.knezevic.edaf.v3.persistence.query.PageResult<T>

public record PageResult<T>(List<T> items, int page, int size, long total, long totalPages) extends Record
Generic page envelope for API and repository responses.
  • Constructor Summary

    Constructors
    Constructor
    Description
    PageResult(List<T> items, int page, int size, long total, long totalPages)
    Creates an instance of a PageResult record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the items record component.
    int
    Returns the value of the page record component.
    int
    Returns the value of the size record component.
    final String
    Returns a string representation of this record class.
    long
    Returns the value of the total record component.
    long
    Returns the value of the totalPages record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • PageResult

      public PageResult(List<T> items, int page, int size, long total, long totalPages)
      Creates an instance of a PageResult record class.
      Parameters:
      items - the value for the items record component
      page - the value for the page record component
      size - the value for the size record component
      total - the value for the total record component
      totalPages - the value for the totalPages 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.
    • items

      public List<T> items()
      Returns the value of the items record component.
      Returns:
      the value of the items record component
    • page

      public int page()
      Returns the value of the page record component.
      Returns:
      the value of the page record component
    • size

      public int size()
      Returns the value of the size record component.
      Returns:
      the value of the size record component
    • total

      public long total()
      Returns the value of the total record component.
      Returns:
      the value of the total record component
    • totalPages

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