com.symphony.bdk.core.service.pagination

Class PaginatedService<T>

java.lang.Object

com.symphony.bdk.core.service.pagination.PaginatedService<T>

Type Parameters:

T - the type of objects to retrieve

@API(status=INTERNAL)
public class PaginatedService<T>
extends java.lang.Object

Retrieve a list of elements given a PaginatedApi. Goal is to fetch elements lazily.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PAGINATION_CHUNK_SIZE
static int	DEFAULT_PAGINATION_TOTAL_SIZE

Constructor Summary

Constructors

Constructor and Description
PaginatedService(PaginatedApi<T> paginatedApi, int chunkSize, int maxSize) The only constructor

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<T>	iterator() Returns an iterator of elements with lazy fetching.
java.util.stream.Stream<T>	stream() Returns an stream of elements with lazy fetching.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGINATION_CHUNK_SIZE

public static final int DEFAULT_PAGINATION_CHUNK_SIZE

See Also:

Constant Field Values

DEFAULT_PAGINATION_TOTAL_SIZE

public static final int DEFAULT_PAGINATION_TOTAL_SIZE

See Also:

Constant Field Values

Constructor Detail

PaginatedService

public PaginatedService(PaginatedApi<T> paginatedApi,
                        int chunkSize,
                        int maxSize)

The only constructor

Parameters:

paginatedApi - the paginated api used to retrieve the chunks of elements

chunkSize - the maximum number to retrieve in one call of PaginatedApi.get(int, int)

maxSize - the maximum number to retrieve in total

Method Detail

iterator

public java.util.Iterator<T> iterator()

Returns an iterator of elements with lazy fetching.

Returns:

an Iterator which lazily makes calls to the PaginatedApi.

stream

public java.util.stream.Stream<T> stream()

Returns an stream of elements with lazy fetching.

Returns:

a Stream which lazily makes calls to the PaginatedApi.