Package com.broadleafcommerce.search.api.domain

Record Class PagedModel.PageMetadata

java.lang.Object
java.lang.Record
com.broadleafcommerce.search.api.domain.PagedModel.PageMetadata
Enclosing class:
PagedModel<T>
public static record PagedModel.PageMetadata(long pageSize, long pageNumber, long offset, boolean paged, boolean unpaged, org.springframework.data.domain.Sort sort) extends Record

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageMetadata(long pageSize, long pageNumber, long offset, boolean paged, boolean unpaged, org.springframework.data.domain.Sort sort)
    Creates an instance of a PageMetadata 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.
    long
    offset()
    Returns the value of the offset record component.
    boolean
    paged()
    Returns the value of the paged record component.
    long
    pageNumber()
    Returns the value of the pageNumber record component.
    long
    pageSize()
    Returns the value of the pageSize record component.
    org.springframework.data.domain.Sort
    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

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • PageMetadata

      public PageMetadata(long pageSize, long pageNumber, long offset, boolean paged, boolean unpaged, org.springframework.data.domain.Sort sort)
      Creates an instance of a PageMetadata record class.
      Parameters:
      pageSize - the value for the pageSize record component
      pageNumber - the value for the pageNumber record component
      offset - the value for the offset record component
      paged - the value for the paged record component
      unpaged - the value for the unpaged record component
      sort - the value for the sort 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 '=='.
      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.

    • pageSize

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

    • pageNumber

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

    • offset

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

    • paged

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

    • unpaged

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

    • sort

      public org.springframework.data.domain.Sort sort()
      Returns the value of the sort record component.
      Returns:
      the value of the sort record component