org.hawkular.alerts.api.model.paging

Class PageContext

java.lang.Object

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

Direct Known Subclasses:

Pager

public class PageContext
extends Object

Since:

0.0.1

Author:

Lukas Krejci

Field Summary

Fields

Modifier and Type	Field and Description
static int	UNLIMITED_PAGE_SIZE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getEnd() If this page context is limited, then this returns getStart() + pageSize.
List<Order>	getOrder() This list of ordering fields.
int	getPageNumber()
int	getPageSize() The associated Page objects should contain at most this number of elements.
int	getStart() This trivially translates to pageNumber * pageSize.
int	hashCode()
boolean	isLimited() Page size less then zero represents no limit on the size of the page.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

UNLIMITED_PAGE_SIZE

public static final int UNLIMITED_PAGE_SIZE

See Also:

Constant Field Values

Constructor Detail

PageContext

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

PageContext

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

Method Detail

getPageNumber

public int getPageNumber()

Returns:

the number of the page this context represents (0-based)

getPageSize

public int getPageSize()

The associated Page objects should contain at most this number of elements.

Returns:

the page size that is being used

getStart

public int getStart()

This trivially translates to pageNumber * pageSize.

Returns:

the index of the first element in the overall results that belongs to the page designated by this context

getEnd

public int getEnd()

If this page context is limited, then this returns getStart() + pageSize. If this page context IS unlimited, Integer.MAX_VALUE is returned.

Returns:

the index just after the last element in the overall results the page designated by this context represents

isLimited

public boolean isLimited()

Page size less then zero represents no limit on the size of the page. Effectively, page contexts like that will always represent the first (and only) page of the results.

Returns:

true if the page size is less than zero

getOrder

public List<Order> getOrder()

This list of ordering fields.

Returns:

the unmodifiable list of ordering fields.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object