Package software.amazon.awssdk.services.dynamodb.document.internal

Class PageBasedCollection<T,R>

java.lang.Object

software.amazon.awssdk.services.dynamodb.document.internal.PageBasedCollection<T,R>

Type Parameters:

T - resource type

R - low level outcome/result type

All Implemented Interfaces:

Iterable<T>

Direct Known Subclasses:

ItemCollection, TableCollection

public abstract class PageBasedCollection<T,R>
extends Object
implements Iterable<T>

Abstract base class for all page-based collections.

Constructor Summary

Constructors

Constructor	Description
PageBasedCollection()

Method Summary

Modifier and Type	Method	Description
abstract Page<T,R>	firstPage()
R	getLastLowLevelResult()	Returns the low-level result last retrieved (for the current page) from the server side; or null if there has yet no calls to the server.
abstract Integer	getMaxResultSize()	Returns the maximum number of resources to be retrieved in this collection; or null if there is no limit.
IteratorSupport<T,R>	iterator()
PageIterable<T,R>	pages()
LowLevelResultListener<R>	registerLowLevelResultListener(LowLevelResultListener<R> listener)	Used to register a listener for the event of receiving a low-level result from the server side.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from class java.lang.Object

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

Constructor Detail

PageBasedCollection

public PageBasedCollection()

Method Detail

iterator

public IteratorSupport<T,R> iterator()

Specified by:

iterator in interface Iterable<T>

pages

public PageIterable<T,R> pages()

firstPage

public abstract Page<T,R> firstPage()

getMaxResultSize

public abstract Integer getMaxResultSize()

Returns the maximum number of resources to be retrieved in this collection; or null if there is no limit.

getLastLowLevelResult

public R getLastLowLevelResult()

Returns the low-level result last retrieved (for the current page) from the server side; or null if there has yet no calls to the server.

registerLowLevelResultListener

public LowLevelResultListener<R> registerLowLevelResultListener(LowLevelResultListener<R> listener)

Used to register a listener for the event of receiving a low-level result from the server side.

Parameters:

listener - listener to be registered. If null, a "none" listener will be set.

Returns:

the previously registered listener. The return value is never null.