Package dev.dokimos.server.dto.v1

Record Class PageResponse<T>

java.lang.Object
java.lang.Record
dev.dokimos.server.dto.v1.PageResponse<T>
public record PageResponse<T>(List<T> content, int number, int size, long totalElements, int totalPages, boolean first, boolean last, int numberOfElements, boolean empty, PageResponse.PageSort sort, PageResponse.PageablePage pageable) extends Record
Stable page envelope used by paginated endpoints. The JSON shape mirrors Spring's default Page<T> serialization field-for-field (including the nested sort and pageable objects) so a single generated client type can deserialize responses from any paginated endpoint regardless of whether the controller returns Page<T> directly or wraps it in this DTO.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    PageResponse.PageablePage
    Mirrors Spring's PageableObject JSON shape.
    static final record 
    PageResponse.PageSort
    Mirrors Spring's SortObject JSON shape.

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageResponse(List<T> content, int number, int size, long totalElements, int totalPages, boolean first, boolean last, int numberOfElements, boolean empty, PageResponse.PageSort sort, PageResponse.PageablePage pageable)
    Creates an instance of a PageResponse record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    List<T>
    content()
    Returns the value of the content record component.
    boolean
    empty()
    Returns the value of the empty record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    boolean
    first()
    Returns the value of the first record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    last()
    Returns the value of the last record component.
    int
    number()
    Returns the value of the number record component.
    int
    numberOfElements()
    Returns the value of the numberOfElements record component.
    static <T> PageResponse<T>
    of(org.springframework.data.domain.Page<T> page)
     
    PageResponse.PageablePage
    pageable()
    Returns the value of the pageable record component.
    int
    size()
    Returns the value of the size record component.
    PageResponse.PageSort
    sort()
    Returns the value of the sort record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    totalElements()
    Returns the value of the totalElements record component.
    int
    totalPages()
    Returns the value of the totalPages record component.

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PageResponse

      public PageResponse(List<T> content, int number, int size, long totalElements, int totalPages, boolean first, boolean last, int numberOfElements, boolean empty, PageResponse.PageSort sort, PageResponse.PageablePage pageable)
      Creates an instance of a PageResponse record class.
      Parameters:
      content - the value for the content record component
      number - the value for the number record component
      size - the value for the size record component
      totalElements - the value for the totalElements record component
      totalPages - the value for the totalPages record component
      first - the value for the first record component
      last - the value for the last record component
      numberOfElements - the value for the numberOfElements record component
      empty - the value for the empty record component
      sort - the value for the sort record component
      pageable - the value for the pageable record component

  • Method Details

    • of

      public static <T> PageResponse<T> of(org.springframework.data.domain.Page<T> page)

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

    • content

      public List<T> content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component

    • number

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

    • size

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

    • totalElements

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

    • totalPages

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

    • first

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

    • last

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

    • numberOfElements

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

    • empty

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

    • sort

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

    • pageable

      public PageResponse.PageablePage pageable()
      Returns the value of the pageable record component.
      Returns:
      the value of the pageable record component