com.blazebit.persistence

Interface PagedList<T>

Type Parameters:

T - the type of elements in this list

All Superinterfaces:

Collection<T>, Iterable<T>, List<T>

public interface PagedList<T>
extends List<T>

An extended version of a List which also provides access to the total size of the list.

Since:

1.0

Author:

Christian Beikov

Method Summary

Methods

Modifier and Type	Method and Description
int	getFirstResult() Returns the position of the first result, numbered from 0.
KeysetPage	getKeysetPage() Returns the key set page for this paged list which can be used for key set pagination.
int	getMaxResults() Returns the maximum number of results.
int	getPage() Returns the number of this page, numbered from 1.
int	getSize() Returns the actual size of this page.
int	getTotalPages() Returns the number of total pages.
long	getTotalSize() Returns the total size of the list.

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Method Detail

getSize

int getSize()

Returns the actual size of this page.

Returns:

The actual size

See Also:

List.size()

getTotalSize

long getTotalSize()

Returns the total size of the list.

Returns:

The total size

getPage

int getPage()

Returns the number of this page, numbered from 1.

Returns:

The number of this page

getTotalPages

int getTotalPages()

Returns the number of total pages.

Returns:

The number of total pages

getFirstResult

int getFirstResult()

Returns the position of the first result, numbered from 0. This is the position which was actually queried. This value might be different from KeysetPage.getFirstResult(). If this list was queried with an entity id which does not exist, this will return -1;

Returns:

The position of the first result or -1 if the queried entity id does not exist

getMaxResults

int getMaxResults()

Returns the maximum number of results. This is the maximum number which was actually queried. This value might be different from KeysetPage.getFirstResult().

Returns:

The maximum number of results

getKeysetPage

KeysetPage getKeysetPage()

Returns the key set page for this paged list which can be used for key set pagination. The key set page may be null if key set pagination wasn't used.

Returns:

The key set

See Also:

QueryBuilder.page(com.blazebit.persistence.KeysetPage, int, int)