Package codes.thischwa.cf.model

Record Class ResultInfo

java.lang.Object
java.lang.Record
codes.thischwa.cf.model.ResultInfo
public record ResultInfo(int page, int perPage, int totalPages, int count, int totalCount) extends Record
Represents metadata for paginated results.

This class contains information about the current page, page size, total pages, and result counts, which can be utilized in managing and navigating through paginated data.

  • page: The current page number.
  • perPage: The number of results per page.
  • totalPages: The total number of pages available.
  • count: The number of results on the current page.
  • totalCount: The total number of results across all pages.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResultInfo(int totalCount)
    Constructs a ResultInfo instance with the specified total count and default values for other fields.
    ResultInfo(int page, int perPage, int totalPages, int count, int totalCount)
    Creates an instance of a ResultInfo record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    count()
    Returns the value of the count 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
    page()
    Returns the value of the page record component.
    int
    perPage()
    Returns the value of the perPage record component.
    final String
    toString()
    Returns a string representation of this record class.
    int
    totalCount()
    Returns the value of the totalCount record component.
    int
    totalPages()
    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

    • ResultInfo

      public ResultInfo(int totalCount)
      Constructs a ResultInfo instance with the specified total count and default values for other fields. Just to use in tests!
      Parameters:
      totalCount - the total number of results across all pages

    • ResultInfo

      public ResultInfo(int page, int perPage, int totalPages, int count, int totalCount)
      Creates an instance of a ResultInfo record class.
      Parameters:
      page - the value for the page record component
      perPage - the value for the perPage record component
      totalPages - the value for the totalPages record component
      count - the value for the count record component
      totalCount - the value for the totalCount 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.

    • page

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

    • perPage

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

    • totalPages

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

    • count

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

    • totalCount

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