Package dev.dokimos.server.dto.v1

Record Class PageResponse.PageablePage

java.lang.Object
java.lang.Record
dev.dokimos.server.dto.v1.PageResponse.PageablePage
Enclosing class:
PageResponse<T>
public static record PageResponse.PageablePage(long offset, PageResponse.PageSort sort, boolean paged, int pageNumber, int pageSize, boolean unpaged) extends Record
Mirrors Spring's PageableObject JSON shape.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageablePage(long offset, PageResponse.PageSort sort, boolean paged, int pageNumber, int pageSize, boolean unpaged)
    Creates an instance of a PageablePage record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    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.
    static PageResponse.PageablePage
    of(org.springframework.data.domain.Pageable pageable)
     
    long
    offset()
    Returns the value of the offset record component.
    boolean
    paged()
    Returns the value of the paged record component.
    int
    pageNumber()
    Returns the value of the pageNumber record component.
    int
    pageSize()
    Returns the value of the pageSize record component.
    PageResponse.PageSort
    sort()
    Returns the value of the sort record component.
    final String
    toString()
    Returns a string representation of this record class.
    boolean
    unpaged()
    Returns the value of the unpaged record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PageablePage

      public PageablePage(long offset, PageResponse.PageSort sort, boolean paged, int pageNumber, int pageSize, boolean unpaged)
      Creates an instance of a PageablePage record class.
      Parameters:
      offset - the value for the offset record component
      sort - the value for the sort record component
      paged - the value for the paged record component
      pageNumber - the value for the pageNumber record component
      pageSize - the value for the pageSize record component
      unpaged - the value for the unpaged record component

  • Method Details

    • of

      public static PageResponse.PageablePage of(org.springframework.data.domain.Pageable pageable)

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

    • offset

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

    • sort

      public PageResponse.PageSort sort()
      Returns the value of the sort record component.
      Returns:
      the value of the sort record component

    • paged

      public boolean paged()
      Returns the value of the paged record component.
      Returns:
      the value of the paged record component

    • pageNumber

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

    • pageSize

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

    • unpaged

      public boolean unpaged()
      Returns the value of the unpaged record component.
      Returns:
      the value of the unpaged record component