Field Detail

• DEFAULT_PAGE_SIZE

  public static final int DEFAULT_PAGE_SIZE

  Default page size (100).

  See Also:

  setPageSize(), Constant Field Values

Constructor Detail

• NavigableSetPager

  public NavigableSetPager()

Method Detail

• setPageSize

  public void setPageSize(int pageSize)

  Set the page size.

  Parameters:

  pageSize - maximum number of rows in a page

  Throws:

  IllegalArgumentException - if pageSize is zero or less

• isDescending

  public boolean isDescending()

  Get view ordering. Default is ascending.

  Returns:

  false if container order is ascending, true if descending

• setDescending

  public void setDescending(boolean descending)

  Set view ordering.

  Parameters:

  descending - true for descending view, false for ascending view

• setFilter

  public void setFilter(Predicate<? super E> filter)

  Filter which items in the set are returned.

  Items that fail to pass the specified filter are omitted from the results and do not contribute to the page total. Beware that a filter can reject arbitrarily many items and therefore when using filters the time it takes to load a full page is potentially unbounded.

  Parameters:

  filter - filter that accepts only the desired items, or null to accept all

• hasNextPage

  public boolean hasNextPage()

  Indicates that there are more results after the current page.

  Returns:

  true if there are more results in the forward direction, false if we are on the last page

• hasPrevPage

  public boolean hasPrevPage()

  Indicates that there are more results before the current page.

  Returns:

  true if there are more results in the reverse direction, false if we are on the first page

• nextPage

  public boolean nextPage()

  Advance forward to the next page of results, if any.

  This will advance to the next higher page of results if configured for an ascending view, or the next lower page of results if configured for a descending view.

  After invoking this method, readCurrentPage() must be invoked for it to take effect. Duplicate invocations of this method without an intervening call to readCurrentPage() will have no effect and return false.

  Returns:

  true if successful, false if we were already on the last page

• prevPage

  public boolean prevPage()

  Advance backward to the previous page of results, if any.

  This will regress to be the next lower page of results if configured for an ascending view, or the next higher page of results if configured for a descending view.

  After invoking this method, readCurrentPage() must be invoked for it to take effect. Duplicate invocations of this method without an intervening call to readCurrentPage() will have no effect and return false.

  Returns:

  true if successful, false if we were already on the first page

• firstPage

  public void firstPage()

  Jump to the first page.

• lastPage

  public void lastPage()

  Jump to the last page.

• setCursor

  public void setCursor(E cursor)

  Set the current cursor position, i.e., page anchor.

  The next page returned by readCurrentPage() will start at cursor, inclusive for an ascending ordering or exclusive for a descending ordering.

  The cursor must not be null unless the underlying NavigableSet supports null values.

  Parameters:

  cursor - new cursor position for the current page

• readCurrentPage

  public List<E> readCurrentPage()

  Read the contents of the current page.

  The list is read starting from the current cursor position (inclusive for an ascending ordering, exclusive for a descending ordering).

  If configured for an ascending view, the list will have ascending ordering; if configured for a descending view, the list will have descending ordering.

  Returns:

  list of items in the current page

• getNavigableSet

  protected abstract NavigableSet<E> getNavigableSet()

  Get the NavigableSet through which to page.

  This method is invoked anew each time readCurrentPage() is invoked.

  Returns:

  the entire query domain in ascending order