io.apimatic.core.types.pagination

Class PaginatedData<I,P,R,E extends CoreApiException>

java.lang.Object

io.apimatic.core.types.pagination.PaginatedData<I,P,R,E>

public class PaginatedData<I,P,R,E extends CoreApiException>
extends Object

Constructor Summary

Constructors

Constructor and Description
PaginatedData(ApiCall<R,E> apiCall, java.util.function.Function<PageWrapper<I,R>,P> pageCreator, java.util.function.Function<R,List<I>> itemsCreator, PaginationStrategy... strategies)

Method Summary

Modifier and Type	Method and Description
PaginatedData<I,P,R,E>	copy()
CompletableFuture<Boolean>	fetchNextPageAsync() Start fetching the next page asynchronously.
<T> List<T>	getItems(java.util.function.Function<CheckedSupplier<I,E>,T> itemSupplier) Get the items in current page converted to type T.
<T> T	getPage(java.util.function.Function<CheckedSupplier<P,E>,T> pageSupplier) Get the current page converted to type T.
int	getPageSize()
HttpRequest.Builder	getRequestBuilder()
io.apimatic.coreinterfaces.http.response.Response	getResponse()
<T> Iterator<T>	items(java.util.function.Function<CheckedSupplier<I,E>,T> itemSupplier)
<T> Iterator<T>	pages(java.util.function.Function<CheckedSupplier<P,E>,T> pageSupplier)

Methods inherited from class java.lang.Object

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

Constructor Detail

PaginatedData

public PaginatedData(ApiCall<R,E> apiCall,
                     java.util.function.Function<PageWrapper<I,R>,P> pageCreator,
                     java.util.function.Function<R,List<I>> itemsCreator,
                     PaginationStrategy... strategies)

Parameters:

apiCall - ApiCall instance to be paginated.

pageCreator - Converts the PageWrapper into the instance of type P.

itemsCreator - Extract list of items of type I from response.

strategies - List of applicable pagination strategies.

Method Detail

getRequestBuilder

public HttpRequest.Builder getRequestBuilder()

Returns:

RequestBuilder that provided this page

getResponse

public io.apimatic.coreinterfaces.http.response.Response getResponse()

Returns:

Response corresponding to this page

getPageSize

public int getPageSize()

Returns:

Size of this page

getItems

public <T> List<T> getItems(java.util.function.Function<CheckedSupplier<I,E>,T> itemSupplier)

Get the items in current page converted to type T.

Type Parameters:

T - Represents the type of items in list.

Parameters:

itemSupplier - A converter to convert the CheckedSupplier of items to type T.

Returns:

All items in current page converted via itemSupplier.

getPage

public <T> T getPage(java.util.function.Function<CheckedSupplier<P,E>,T> pageSupplier)

Get the current page converted to type T.

Type Parameters:

T - Represents the return type.

Parameters:

pageSupplier - A converter to convert the CheckedSupplier of page to type T.

Returns:

Current page converted via pageSupplier.

items

public <T> Iterator<T> items(java.util.function.Function<CheckedSupplier<I,E>,T> itemSupplier)

Type Parameters:

T - Represents the type of items in iterator.

Parameters:

itemSupplier - A converter to convert the CheckedSupplier of items to type T.

Returns:

An Iterator of all items of type T.

pages

public <T> Iterator<T> pages(java.util.function.Function<CheckedSupplier<P,E>,T> pageSupplier)

Type Parameters:

T - Represents the type of pages in iterator.

Parameters:

pageSupplier - A converter to convert the CheckedSupplier of page to type T.

Returns:

An Iterator of all pages of type T.

copy

public PaginatedData<I,P,R,E> copy()

Returns:

A copy of this instance of PaginatedData.

fetchNextPageAsync

public CompletableFuture<Boolean> fetchNextPageAsync()

Start fetching the next page asynchronously.

Returns:

A CompletableFuture of boolean instance suggesting if there is a next page or not.