org.mule.streaming

Class PagingDelegate<T>

java.lang.Object

org.mule.streaming.PagingDelegate<T>

All Implemented Interfaces:

Closeable

Direct Known Subclasses:

PagingDelegateWrapper

public abstract class PagingDelegate<T>
extends Object
implements Closeable

A PagingDelegate is a Closeable capable of consuming a data feed in pages. Implementing this class does not guarantee thread safeness. Check each particular implementation for information about that

Since:

3.5.0

Constructor Summary

Constructors

Constructor and Description
PagingDelegate()

Method Summary

Methods

Modifier and Type	Method and Description
abstract List<T>	getPage() Returns the next page of items.
abstract int	getTotalResults() returns the total amount of items in the unpaged resultset.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mule.api.Closeable

close

Constructor Detail

PagingDelegate

public PagingDelegate()

Method Detail

getPage

public abstract List<T> getPage()

Returns the next page of items. If the return value is null or an empty list, then it means no more items are available

Returns:

a populated list of elements. null or an empty list, then it means no more items are available

getTotalResults

public abstract int getTotalResults()

returns the total amount of items in the unpaged resultset. In some scenarios, it might not be possible/convenient to actually retrieve this value. -1 is returned in such a case.