Class TableCollection<R>
java.lang.Object
com.amazonaws.services.dynamodbv2.document.internal.PageBasedCollection<Table,R>
com.amazonaws.services.dynamodbv2.document.TableCollection<R>
- Type Parameters:
R
- low level result type
public abstract class TableCollection<R>
extends com.amazonaws.services.dynamodbv2.document.internal.PageBasedCollection<Table,R>
A collection of
Table
's (initialized with the respective table
names).
An TableCollection
object maintains a cursor pointing to its
current pages of data. Initially the cursor is positioned before the first
page. The next method moves the cursor to the next row, and because it
returns false when there are no more rows in the TableCollection
object, it can be used in a while loop to iterate through the collection.
Network calls can be triggered when the collection is iterated across page
boundaries.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns 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
Returns the maximum number of resources to be retrieved in this collection; or null if there is no limit.pages()
Returns anIterable<Page<Table, R>>
that iterates over pages of tables from this collection.Used to register a listener for the event of receiving a low-level result from the server side.Methods inherited from class com.amazonaws.services.dynamodbv2.document.internal.PageBasedCollection
firstPage, iterator, setLastLowLevelResult
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 Details
-
TableCollection
public TableCollection()
-
-
Method Details
-
pages
Returns anIterable<Page<Table, R>>
that iterates over pages of tables from this collection. Each call toIterator.next
on anIterator
returned from thisIterable
results in exactly one call to DynamoDB to retrieve a single page of results.TableCollection<?> collection = ...; for (Page<Table> page : collection.pages()) { processTables(page); }
The use of the internal/undocumented
PageIterable
class instead ofIterable
in the public interface here is retained for backwards compatibility. It doesn't expose any methods beyond those of theIterable
interface. This method will be changed to return anIterable<Page<Table, R>>
directly in a future release of the SDK. -
getMaxResultSize
Returns the maximum number of resources to be retrieved in this collection; or null if there is no limit. -
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
Used to register a listener for the event of receiving a low-level result from the server side.
-