Package org.bremersee.pagebuilder.model

Class AbstractPageDto<T>

java.lang.Object
org.bremersee.pagebuilder.model.AbstractSliceDto<T>
org.bremersee.pagebuilder.model.AbstractPageDto<T>
Type Parameters:
T - the type of the content
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CommonPageDto, JsonPageDto
public abstract class AbstractPageDto<T> extends AbstractSliceDto<T>
The abstract page transfer object.
Author:
Christian Bremer
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected List<T>
    content
    The content.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    AbstractPageDto()
    Instantiates a new abstract page transfer object.
    protected
    AbstractPageDto(List<? extends T> content, int number, int size, long totalElements)
    Instantiates a new abstract page transfer object.
    protected
    AbstractPageDto(List<? extends T> content, int number, int size, long totalElements, SortOrder sort)
    Instantiates a new abstract page transfer object.
    protected
    AbstractPageDto(List<? extends T> content, int number, int size, long totalElements, org.springframework.data.domain.Sort sort)
    Instantiates a new abstract page transfer object.
    protected
    AbstractPageDto(org.springframework.data.domain.Page<? extends T> page)
    Instantiates a new abstract page transfer object.

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract List<T>
    getContent()
    Gets content.
    int
    getNumberOfElements()
    Gets the number of elements.
    org.springframework.data.domain.Pageable
    getPageable()
    Gets pageable.
    SortOrder
    getSort()
    Gets sort.
    long
    getTotalElements()
    Gets total elements.
    int
    getTotalPages()
    Gets total pages.
    boolean
    isContentPresent()
    Indicates whether the content is present.
    boolean
    isFirst()
    Indicates whether the page or slice is the first.
    boolean
    isLast()
    Indicates whether the page or slice is the last.
    boolean
    isNextAvailable()
    Indicates whether a next page or slice is available.
    boolean
    isPreviousAvailable()
    Indicates whether a previous page or slice is available.
    protected void
    setContent(List<T> content)
    Sets content.
    protected void
    setContentPresent(boolean contentPresent)
    Sets content present.
    protected void
    setFirst(boolean first)
    Sets first.
    protected void
    setLast(boolean last)
    Sets last.
    protected abstract void
    setNextAvailable(boolean nextAvailable)
    Sets next available.
    protected abstract void
    setNumber(int number)
    Sets number.
    protected void
    setNumberOfElements(int numberOfElements)
    Sets the number of elements.
    protected void
    setPreviousAvailable(boolean previousAvailable)
    Sets previous available.
    protected abstract void
    setSize(int size)
    Sets size.
    protected void
    setTotalPages(int totalPages)
    Sets total pages.
    org.springframework.data.domain.Page<T>
    toPage()
    To page.
    org.springframework.data.domain.Slice<T>
    toSlice()
    To slice.

    Methods inherited from class org.bremersee.pagebuilder.model.AbstractSliceDto

    getNumber, getSize

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • content

      protected List<T> content
      The content.

  • Constructor Details

    • AbstractPageDto

      protected AbstractPageDto()
      Instantiates a new abstract page transfer object.

    • AbstractPageDto

      protected AbstractPageDto(List<? extends T> content, int number, int size, long totalElements)
      Instantiates a new abstract page transfer object.
      Parameters:
      content - the content
      number - the number
      size - the size
      totalElements - the total elements

    • AbstractPageDto

      protected AbstractPageDto(List<? extends T> content, int number, int size, long totalElements, SortOrder sort)
      Instantiates a new abstract page transfer object.
      Parameters:
      content - the content of the page
      number - the number of the page starting with 0
      size - the size of the page (not the size of the content)
      totalElements - the total elements (the size of available elements)
      sort - the sort oder

    • AbstractPageDto

      protected AbstractPageDto(List<? extends T> content, int number, int size, long totalElements, org.springframework.data.domain.Sort sort)
      Instantiates a new abstract page transfer object.
      Parameters:
      content - the content
      number - the number
      size - the size
      totalElements - the total elements
      sort - the sort

    • AbstractPageDto

      protected AbstractPageDto(org.springframework.data.domain.Page<? extends T> page)
      Instantiates a new abstract page transfer object.
      Parameters:
      page - the page

  • Method Details

    • getTotalElements

      public long getTotalElements()
      Gets total elements.
      Returns:
      the total elements

    • getTotalPages

      public int getTotalPages()
      Gets total pages.
      Returns:
      the total pages

    • setTotalPages

      protected void setTotalPages(int totalPages)
      Sets total pages. This method is ignored.
      Parameters:
      totalPages - the total pages

    • isNextAvailable

      public boolean isNextAvailable()
      Indicates whether a next page or slice is available.
      Overrides:
      isNextAvailable in class AbstractSliceDto<T>
      Returns:
      the boolean

    • toPage

      public org.springframework.data.domain.Page<T> toPage()
      To page.
      Returns:
      the page

    • getContent

      public abstract List<T> getContent()
      Gets content.
      Returns:
      the content

    • setContent

      protected void setContent(List<T> content)
      Sets content.
      Parameters:
      content - the content

    • isContentPresent

      public boolean isContentPresent()
      Indicates whether the content is present.
      Returns:
      the boolean

    • setContentPresent

      protected void setContentPresent(boolean contentPresent)
      Sets content present. This method is ignored.
      Parameters:
      contentPresent - the content present

    • getSort

      public SortOrder getSort()
      Gets sort.
      Returns:
      the sort

    • setNumber

      protected abstract void setNumber(int number)
      Sets number.
      Parameters:
      number - the number

    • setSize

      protected abstract void setSize(int size)
      Sets size.
      Parameters:
      size - the size

    • getNumberOfElements

      public int getNumberOfElements()
      Gets the number of elements.
      Returns:
      the number of elements

    • setNumberOfElements

      protected void setNumberOfElements(int numberOfElements)
      Sets the number of elements. This method is ignored.
      Parameters:
      numberOfElements - the number of elements

    • isFirst

      public boolean isFirst()
      Indicates whether the page or slice is the first.
      Returns:
      the boolean

    • setFirst

      protected void setFirst(boolean first)
      Sets first. This method is ignored.
      Parameters:
      first - the first

    • isLast

      public boolean isLast()
      Indicates whether the page or slice is the last.
      Returns:
      the boolean

    • setLast

      protected void setLast(boolean last)
      Sets last. This method is ignored.
      Parameters:
      last - the last

    • setNextAvailable

      protected abstract void setNextAvailable(boolean nextAvailable)
      Sets next available.
      Parameters:
      nextAvailable - the next available

    • isPreviousAvailable

      public boolean isPreviousAvailable()
      Indicates whether a previous page or slice is available.
      Returns:
      the boolean

    • setPreviousAvailable

      protected void setPreviousAvailable(boolean previousAvailable)
      Sets previous available. This method is ignored.
      Parameters:
      previousAvailable - the previous available

    • getPageable

      public org.springframework.data.domain.Pageable getPageable()
      Gets pageable.
      Returns:
      the pageable

    • toSlice

      public org.springframework.data.domain.Slice<T> toSlice()
      To slice.
      Returns:
      the slice