com.amazonaws.services.dynamodbv2.document.internal

Class PageBasedCollection<T,R>

java.lang.Object

com.amazonaws.services.dynamodbv2.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 and Description
PageBasedCollection()

Method Summary

Modifier and Type	Method and 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() Returns an iterator over elements of type T.
PageIterable<T,R>	pages() Returns an iterator over pages of type T.
LowLevelResultListener<R>	registerLowLevelResultListener(LowLevelResultListener<R> listener) Used to register a listener for the event of receiving a low-level result from the server side.
protected void	setLastLowLevelResult(R lowLevelResult) Internal method used by the implementation layer for setting the low level result received from the server side.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

PageBasedCollection

public PageBasedCollection()

Method Detail

iterator

public IteratorSupport<T,R> iterator()

Returns an iterator over elements of type T. Each call to this method creates an independent iteration over DynamoDB data, with separate calls per iteration.

Specified by:

iterator in interface Iterable<T>

pages

public PageIterable<T,R> pages()

Returns an iterator over pages of type T. Each call to this method creates an independent iteration over DynamoDB data, with separate calls per iteration.

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.

setLastLowLevelResult

protected void setLastLowLevelResult(R lowLevelResult)

Internal method used by the implementation layer for setting the low level result received from the server side.

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.