Package de.kamillionlabs.hateoflux.model.hal

Datensatzklasse HalPageInfo

java.lang.Object
java.lang.Record
de.kamillionlabs.hateoflux.model.hal.HalPageInfo
Datensatzkomponenten:
size - the requested/max number of elements in a single page
totalElements - the total number of elements across all pages
totalPages - the total number of pages
number - the current page number, typically zero-based
public record HalPageInfo(Integer size, Long totalElements, Integer totalPages, Integer number) extends Record
Represents pagination details in a hypermedia-driven format. This record provides necessary information to handle paging of large datasets.

  • Konstruktordetails

    • HalPageInfo

      public HalPageInfo(Integer size, Long totalElements, Integer totalPages, Integer number)
      Erstellt eine Instanz einer Datensatzklasse HalPageInfo.
      Parameter:
      size - Wert für die Datensatzkomponente size
      totalElements - Wert für die Datensatzkomponente totalElements
      totalPages - Wert für die Datensatzkomponente totalPages
      number - Wert für die Datensatzkomponente number

  • Methodendetails

    • of

      public static HalPageInfo of(Integer size, Long totalElements, Integer totalPages, Integer number)
      Creates a HalPageInfo instance using provided individual parameters.
      Parameter:
      size - the requested/max number of elements in a single page
      totalElements - the total number of elements across all pages
      totalPages - the total number of pages calculated from total elements and page size
      number - the current page number
      Gibt zurück:
      a new instance of HalPageInfo

    • assembleWithPageNumber

      public static HalPageInfo assembleWithPageNumber(int size, long totalElements, int number)
      Computes pagination information based on page size, total number of elements, and an optional offset.
      Parameter:
      size - the requested/max number of elements in a single page
      totalElements - the total number of elements across all pages
      number - current page number
      Gibt zurück:
      a new instance of HalPageInfo

    • assembleWithOffset

      public static HalPageInfo assembleWithOffset(int size, long totalElements, @Nullable Long offset)
      Computes pagination information based on page size, total number of elements, and an optional offset.
      Parameter:
      size - the requested/max number of elements in a single page
      totalElements - the total number of elements across all pages
      offset - the offset from which to start pagination, can be null
      Gibt zurück:
      a new instance of HalPageInfo

    • toString

      public final String toString()
      Gibt eine Zeichenfolgendarstellung dieser Datensatzklasse zurück. Die Darstellung enthält den Namen der Klasse, gefolgt vom Namen und Wert jeder der Datensatzkomponenten.
      Angegeben von:
      toString in Klasse Record
      Gibt zurück:
      eine Zeichenfolgendarstellung dieses Objekts

    • hashCode

      public final int hashCode()
      Gibt einen Hashcodewert für diese Objekt zurück. Der Wert wird vom Hashcode jeder der Datensatzkomponenten abgeleitet.
      Angegeben von:
      hashCode in Klasse Record
      Gibt zurück:
      ein Hashcodewert für dieses Objekt

    • equals

      public final boolean equals(Object o)
      Gibt an, ob ein anderes Objekt diesem gleich ("equal to") ist. Die Objekte sind gleich, wenn das andere Objekt der gleichen Klasse angehört und alle Datensatzkomponenten gleich sind. Alle Komponenten in dieser Datensatzklasse werden verglichen mit Objects::equals(Object,Object).
      Angegeben von:
      equals in Klasse Record
      Parameter:
      o - das Objekt, mit dem verglichen wird
      Gibt zurück:
      true, wenn dieses Objekt gleich dem Argument o ist, andernfalls false.

    • size

      public Integer size()
      Gibt den Wert für die Datensatzkomponente size zurück.
      Gibt zurück:
      Wert der Datensatzkomponente size

    • totalElements

      public Long totalElements()
      Gibt den Wert für die Datensatzkomponente totalElements zurück.
      Gibt zurück:
      Wert der Datensatzkomponente totalElements

    • totalPages

      public Integer totalPages()
      Gibt den Wert für die Datensatzkomponente totalPages zurück.
      Gibt zurück:
      Wert der Datensatzkomponente totalPages

    • number

      public Integer number()
      Gibt den Wert für die Datensatzkomponente number zurück.
      Gibt zurück:
      Wert der Datensatzkomponente number