org.mule.runtime.extension.api.introspection.streaming

Interface PagingProvider<C,T>

Type Parameters:

C - connection type expected to handle the operations.

T - the type of the returned pages.

All Superinterfaces:

AutoCloseable, Closeable

public interface PagingProvider<C,T>
extends Closeable

This interface provides functionality for consuming a data feed in pages.

Implementing this interface does not guarantee thread safeness.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
List<T>	getPage(C connection) Returns the next page of items.
Optional<Integer>	getTotalResults(C connection) returns the total amount of items in the non-paged result set.

Methods inherited from interface java.io.Closeable

close

Method Detail

getPage

List<T> getPage(C connection)

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

Parameters:

connection - The connection to be used to do the query.

Returns:

a populated List of elements of type Type, An empty List if no more items are available

getTotalResults

Optional<Integer> getTotalResults(C connection)

returns the total amount of items in the non-paged result set. In some scenarios, it might not be possible/convenient to actually retrieve this value, in such a cases an Optional.empty() value is returned.

Parameters:

connection - The connection to be used to do the query.