org.hawkular.alerts.api.model.paging

Class Pager

java.lang.Object

org.hawkular.alerts.api.model.paging.PageContext

org.hawkular.alerts.api.model.paging.Pager

public final class Pager
extends PageContext

Specifies the requirements on the paging of some results.

Since:

0.0.1

Author:

Lukas Krejci

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pager.Builder

Field Summary

Fields inherited from class org.hawkular.alerts.api.model.paging.PageContext

UNLIMITED_PAGE_SIZE

Constructor Summary

Constructors

Constructor and Description
Pager(int pageNumber, int pageSize, Iterable<Order> orders)
Pager(int pageNumber, int pageSize, Order... orders)

Method Summary

Modifier and Type	Method and Description
static Pager.Builder	builder()
Pager	nextPage() If this is a limited pager (PageContext.isLimited()), returns the pager pointing to the next page of the results.
Pager	previousPage() If this is a limited pager (PageContext.isLimited()), returns the pager pointing to the previous page of the results.
static Pager	unlimited(Iterable<Order> order) Same as unlimited(Order...) but the ordering represented by a collection.
static Pager	unlimited(Order... order) The result should not be paged.

Methods inherited from class org.hawkular.alerts.api.model.paging.PageContext

equals, getEnd, getOrder, getPageNumber, getPageSize, getStart, hashCode, isLimited, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Pager

public Pager(int pageNumber,
             int pageSize,
             Order... orders)

Parameters:

pageNumber - the number of the page to fetch

pageSize - the number of the elements on the page

orders - the ordering of the results required

Pager

public Pager(int pageNumber,
             int pageSize,
             Iterable<Order> orders)

Parameters:

pageNumber - see Pager(int, int, Order...)

pageSize - see Pager(int, int, Order...)

orders - see Pager(int, int, Order...)

See Also:

Pager(int, int, Order...)

Method Detail

builder

public static Pager.Builder builder()

unlimited

public static Pager unlimited(Order... order)

The result should not be paged.

Parameters:

order - the ordering of the results

Returns:

a new pager instance

unlimited

public static Pager unlimited(Iterable<Order> order)

Same as unlimited(Order...) but the ordering represented by a collection.

Parameters:

order - the ordering of the results

Returns:

a new pager instance

nextPage

public Pager nextPage()

If this is a limited pager (PageContext.isLimited()), returns the pager pointing to the next page of the results. If this is an unlimited pager, then simply returns this very pager because there can be no other page of the results.

Returns:

a new pager instance

previousPage

public Pager previousPage()

If this is a limited pager (PageContext.isLimited()), returns the pager pointing to the previous page of the results. If this is an unlimited pager, then simply returns this very pager because there can be no other page of the results.

Returns:

a new pager instance