org.alfresco.rest.framework.resource.parameters

Class CollectionWithPagingInfo<T>

java.lang.Object

org.alfresco.rest.framework.resource.parameters.CollectionWithPagingInfo<T>

public class CollectionWithPagingInfo<T>
extends Object

A wrapper around Collection that supports paging information. CollectionWithPagingInfo is immutable and collections are unmodifiable. Use the asPaged methods to construct it. collection - The collection hasMoreItems - Indicates the total number of items available. Can be greater than the number of items returned in the list. totalItems - Indicates the total number of items available. Can be greater than the number of items returned in the list.

Author:

Gethin James.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CollectionWithPagingInfo(Collection<T> collection, Paging paging, boolean hasMoreItems, Integer totalItems) Constructs a new CollectionWithPagingInfo.

Method Summary

Methods

Modifier and Type	Method and Description
static <T> CollectionWithPagingInfo<T>	asPaged(Paging paging, Collection<T> aCollection) Constructs a new CollectionWithPagingInfo.
static <T> CollectionWithPagingInfo<T>	asPaged(Paging paging, Collection<T> aCollection, boolean hasMoreItems, Integer totalItems) Constructs a new CollectionWithPagingInfo.
static <T> CollectionWithPagingInfo<T>	asPagedCollection(T... entity) Constructs a new CollectionWithPagingInfo using a number of entity values.
Collection<T>	getCollection() Returns the Collection object
Paging	getPaging() The requested paging parameters set by the client
Integer	getTotalItems() Indicates the total number of items available.
boolean	hasMoreItems() Indicates if the returned collection has more items after the current returned list.

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionWithPagingInfo

protected CollectionWithPagingInfo(Collection<T> collection,
                        Paging paging,
                        boolean hasMoreItems,
                        Integer totalItems)

Constructs a new CollectionWithPagingInfo.

Parameters:

aCollection - - the collection that needs to be paged.

hasMoreItems - - Are there more items after this Collection?

paging - - Paging request info

totalItems - - The total number of items available.

Method Detail

asPaged

public static <T> CollectionWithPagingInfo<T> asPaged(Paging paging,
                                      Collection<T> aCollection)

Constructs a new CollectionWithPagingInfo. It automatically sets the total items based on the collection size and sets the hasMoreItems variable to false.

Parameters:

paging - - Paging request info

aCollection - - the collection that needs to be paged.

Returns:

CollectionWithPagingInfo

asPagedCollection

public static <T> CollectionWithPagingInfo<T> asPagedCollection(T... entity)

Constructs a new CollectionWithPagingInfo using a number of entity values. It automatically creates a Collection, sets the total items and sets the hasMoreItems variable to false. Paging is set to the default values.

Parameters:

entity - - the entities to turn into a collection

Returns:

CollectionWithPagingInfo

asPaged

public static <T> CollectionWithPagingInfo<T> asPaged(Paging paging,
                                      Collection<T> aCollection,
                                      boolean hasMoreItems,
                                      Integer totalItems)

Constructs a new CollectionWithPagingInfo.

Parameters:

paging - - Paging request info

aCollection - - the collection that needs to be paged.

hasMoreItems - - Are there more items after this Collection?

totalItems - - The total number of items available.

Returns:

CollectionWithPagingInfo

getCollection

public Collection<T> getCollection()

Returns the Collection object

Returns:

Collection

hasMoreItems

public boolean hasMoreItems()

Indicates if the returned collection has more items after the current returned list.

Parameters:

hasMoreItems -

getTotalItems

public Integer getTotalItems()

Indicates the total number of items available. Can be greater than the number of items returned in the list.

getPaging

public Paging getPaging()

The requested paging parameters set by the client