Package org.apache.maven.search.api.request

Class Paging

java.lang.Object
org.apache.maven.search.api.request.Paging
public class Paging extends Object
Paging.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected final int
    pageOffset
     
    protected final int
    pageSize
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Paging(int pageSize)
    Creates paging instance with given page size (must be grater than 0) and 0 page offset.
    Paging(int pageSize, int pageOffset)
    Creates paging instance with given page size (must be greater than 0) and page offset (must be non-negative).

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getPageOffset()
    Returns the page offset: a zero or a positive integer.
    int
    getPageSize()
    Returns the page size: positive integer, never zero or less.
    Paging
    nextPage()
    Creates "next page" instance relative to this instance.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Field Details

    • pageSize

      protected final int pageSize

    • pageOffset

      protected final int pageOffset

  • Constructor Details

    • Paging

      public Paging(int pageSize, int pageOffset)
      Creates paging instance with given page size (must be greater than 0) and page offset (must be non-negative).

    • Paging

      public Paging(int pageSize)
      Creates paging instance with given page size (must be grater than 0) and 0 page offset.

  • Method Details

    • getPageSize

      public int getPageSize()
      Returns the page size: positive integer, never zero or less.

    • getPageOffset

      public int getPageOffset()
      Returns the page offset: a zero or a positive integer.

    • nextPage

      public Paging nextPage()
      Creates "next page" instance relative to this instance.

    • toString

      public String toString()
      Overrides:
      toString in class Object