com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper

Class PaginatedScanList<T>

java.lang.Object

com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.PaginatedList<T>

com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.PaginatedScanList<T>

Type Parameters:

T - The type of objects held in this list.

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>

public class PaginatedScanList<T>
extends PaginatedList<T>

Implementation of the List interface that represents the results from a scan in AWS DynamoDB. Paginated results are loaded on demand when the user executes an operation that requires them. Some operations, such as size(), must fetch the entire list, but results are lazily fetched page by page when possible.

This is an unmodifiable list, so callers should not invoke any operations that modify this list, otherwise they will throw an UnsupportedOperationException.

See Also:

PaginatedList

Field Summary

Fields inherited from class com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.PaginatedList

allResults, allResultsLoaded, clazz, dynamo, mapper, nextResults

Constructor Summary

Constructors

Constructor and Description
PaginatedScanList(DynamoDBMapper mapper, Class<T> clazz, AmazonDynamoDB dynamo, ScanRequest scanRequest, ScanResult scanResult, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy, DynamoDBMapperConfig config) Constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	atEndOfResults() Returns whether we have reached the end of the result set.
protected List<T>	fetchNextPage() Fetches the next page of results (which may be empty) and returns any items found.

Methods inherited from class com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.PaginatedList

add, add, addAll, addAll, clear, contains, containsAll, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, loadAllResults, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode, replaceAll, sort, spliterator

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

PaginatedScanList

public PaginatedScanList(DynamoDBMapper mapper,
                         Class<T> clazz,
                         AmazonDynamoDB dynamo,
                         ScanRequest scanRequest,
                         ScanResult scanResult,
                         DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy,
                         DynamoDBMapperConfig config)

Constructor.

Parameters:

mapper - an instance of DynamoDBMapper

clazz - the class that is being mapped to a dynamodb table

dynamo - an instance of AmazonDynamoDB

scanRequest - a ScanRequest

scanResult - a ScanResult

paginationLoadingStrategy - DynamoDBMapperConfig.PaginationLoadingStrategy

config - the DynamoDBMapperConfig

Method Detail

atEndOfResults

protected boolean atEndOfResults()

Description copied from class: PaginatedList

Returns whether we have reached the end of the result set.

Specified by:

atEndOfResults in class PaginatedList<T>

fetchNextPage

protected List<T> fetchNextPage()

Description copied from class: PaginatedList

Fetches the next page of results (which may be empty) and returns any items found.

Specified by:

fetchNextPage in class PaginatedList<T>