com.evrythng.commons

Class PaginatedList<E>

java.lang.Object

com.evrythng.commons.PaginatedList<E>

public class PaginatedList<E>
extends Object

List that represent only a portion of the full list. The items are not copied, so any change to the list supplied will be reflected to this list. If the supplied list is changed, the behavior of the instance of this class is undefined.

Author:

Michel Yerly (my)

Constructor Summary

Constructors

Constructor and Description
PaginatedList() Creates an empty list.
PaginatedList(E item) Constructs a paginated list with zero or one item.
PaginatedList(List<E> items) Creates a list with the items specified.
PaginatedList(List<E> items, long totalCount, long itemStart, long itemsPerPage) Creates a list with the items specified.
PaginatedList(List<E> items, long totalCount, Pagination pagination) Creates a list with the items specified.
PaginatedList(List<E> items, Pagination pagination, Long totalCount)
PaginatedList(List<E> items, Ref<Long> totalCount, Pagination pagination)

Method Summary

Modifier and Type	Method and Description
List<E>	getItems() Gets the items as an unmodifiable list.
long	getItemsPerPage()
long	getItemStart()
long	getPage()
long	getPages()
long	getTotalCount()
boolean	isFirstPage()
boolean	isLastPage()
<T> PaginatedList<T>	withElements(List<T> elements)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaginatedList

public PaginatedList()

Creates an empty list.

PaginatedList

public PaginatedList(List<E> items)

Creates a list with the items specified. items represent the entire list.

PaginatedList

public PaginatedList(List<E> items,
                     long totalCount,
                     Pagination pagination)

Creates a list with the items specified.

PaginatedList

public PaginatedList(List<E> items,
                     Pagination pagination,
                     Long totalCount)

PaginatedList

public PaginatedList(List<E> items,
                     Ref<Long> totalCount,
                     Pagination pagination)

PaginatedList

public PaginatedList(List<E> items,
                     long totalCount,
                     long itemStart,
                     long itemsPerPage)

Creates a list with the items specified.

PaginatedList

public PaginatedList(E item)

Constructs a paginated list with zero or one item.

Parameters:

item - The item. If null, it is not added.

Method Detail

withElements

public final <T> PaginatedList<T> withElements(List<T> elements)

getItems

public List<E> getItems()

Gets the items as an unmodifiable list. NOTE: the object is not the same as the one passed in the constructor (if any).

getTotalCount

public long getTotalCount()

getItemStart

public long getItemStart()

getItemsPerPage

public long getItemsPerPage()

isFirstPage

public boolean isFirstPage()

isLastPage

public boolean isLastPage()

getPage

public long getPage()

getPages

public long getPages()