Class Paging


  • public final class Paging
    extends java.lang.Object
    Immutable paging configuration. The paging is used to address a sub list that can be retrieved in one logical page. This enables the client to itereate thru a long list without needing to store the whole result in memory.
    Author:
    Stephan fuhrmann
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static Paging DEFAULT_START
      A default start page with offset 0 and limit 64.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Paging at​(int offset, int limit)
      Creates a new paging at the given offset and limit.
      Paging next()
      Address the next paging.
      Paging previous()
      Address the previous paging.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • DEFAULT_START

        public static final Paging DEFAULT_START
        A default start page with offset 0 and limit 64.
    • Method Detail

      • at

        public static Paging at​(int offset,
                                int limit)
        Creates a new paging at the given offset and limit.
        Parameters:
        offset - the positive offset of the page.
        limit - the maximum number of entries.
        Returns:
        the paging instance created.
      • previous

        public Paging previous()
        Address the previous paging. Will never go beyond offset 0.
        Returns:
        returns the paging at offset - limit and keeps the limit. Will return 0 if going beyond offset 0.
      • next

        public Paging next()
        Address the next paging.
        Returns:
        returns the paging at offset + limit and keeps the limit.