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

java.lang.Object
  com.amazonaws.mobileconnectors.dynamodbv2.dynamodbmapper.PaginatedList<T>

Type Parameters:

T - The domain object type stored in this list.

All Implemented Interfaces:

java.lang.Iterable<T>, java.util.Collection<T>, java.util.List<T>

Direct Known Subclasses:

PaginatedParallelScanList, PaginatedQueryList, PaginatedScanList

public abstract class PaginatedList<T>
extends java.lang.Object
implements java.util.List<T>

Unmodifiable list supporting paginated result sets from Amazon DynamoDB.

Pages of results are fetched lazily from DynamoDB as they are needed. Some methods, such as size() and toArray(), require fetching the entire result set eagerly. See the javadoc of individual methods for details on which are lazy.

Constructor Summary

PaginatedList(DynamoDBMapper mapper, java.lang.Class<T> clazz, AmazonDynamoDB dynamo)
Constructs a PaginatedList instance using the default PaginationLoadingStrategy

PaginatedList(DynamoDBMapper mapper, java.lang.Class<T> clazz, AmazonDynamoDB dynamo, DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)
Constructs a PaginatedList instance.

Method Summary

void	add(int arg0, T arg1)
boolean	add(T arg0)
boolean	addAll(java.util.Collection<? extends T> arg0)
boolean	addAll(int arg0, java.util.Collection<? extends T> arg1)
void	clear()
boolean	contains(java.lang.Object arg0) Returns whether the collection contains the given element.
boolean	containsAll(java.util.Collection<?> arg0)
T	get(int n) Returns the Nth element of the list.
int	indexOf(java.lang.Object arg0) Returns the first index of the object given in the list.
boolean	isEmpty() Returns whether the collection is empty.
java.util.Iterator<T>	iterator() Returns an iterator over this list that lazily initializes results as necessary.
int	lastIndexOf(java.lang.Object arg0)
java.util.ListIterator<T>	listIterator()
java.util.ListIterator<T>	listIterator(int arg0)
void	loadAllResults() Eagerly loads all results for this list.
T	remove(int arg0)
boolean	remove(java.lang.Object arg0)
boolean	removeAll(java.util.Collection<?> arg0)
boolean	retainAll(java.util.Collection<?> arg0)
T	set(int arg0, T arg1)
int	size()
java.util.List<T>	subList(int arg0, int arg1) Returns a sub-list in the range specified, loading more results as necessary.
java.lang.Object[]	toArray()
<X> X[]	toArray(X[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.List

equals, hashCode

Constructor Detail

PaginatedList

public PaginatedList(DynamoDBMapper mapper,
                     java.lang.Class<T> clazz,
                     AmazonDynamoDB dynamo)

Constructs a PaginatedList instance using the default PaginationLoadingStrategy

PaginatedList

public PaginatedList(DynamoDBMapper mapper,
                     java.lang.Class<T> clazz,
                     AmazonDynamoDB dynamo,
                     DynamoDBMapperConfig.PaginationLoadingStrategy paginationLoadingStrategy)

Constructs a PaginatedList instance.

Parameters:

mapper - The mapper for marshalling DynamoDB attributes into objects.

clazz - The class of the annotated model.

dynamo - The DynamoDB client for making low-level request calls.

paginationLoadingStrategy - The strategy used for loading paginated results. Caller has to explicitly set this parameter, since the DynamoDBMapperConfig set in the mapper is not accessible here. If null value is provided, LAZY_LOADING will be set by default.

Method Detail

loadAllResults

public void loadAllResults()

Eagerly loads all results for this list.

Not supported in ITERATION_ONLY mode.

iterator

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

Returns an iterator over this list that lazily initializes results as necessary.

If it configured with ITERARTION_ONLY mode, then the iterator could be only retrieved once, and any previously loaded results will be cleared in the memory during the iteration.

Specified by:

iterator in interface java.lang.Iterable<T>

Specified by:

iterator in interface java.util.Collection<T>

Specified by:

iterator in interface java.util.List<T>

isEmpty

public boolean isEmpty()

Returns whether the collection is empty. At most one (non-empty) page of results is loaded to make the check.

Not supported in ITERATION_ONLY mode.

Specified by:

isEmpty in interface java.util.Collection<T>

Specified by:

isEmpty in interface java.util.List<T>

get

public T get(int n)

Returns the Nth element of the list. Results are loaded until N elements are present, if necessary.

Not supported in ITERATION_ONLY mode.

Specified by:

get in interface java.util.List<T>

contains

public boolean contains(java.lang.Object arg0)

Returns whether the collection contains the given element. Results are loaded and checked incrementally until a match is found or the end of the result set is reached.

Not supported in ITERATION_ONLY mode.

Specified by:

contains in interface java.util.Collection<T>

Specified by:

contains in interface java.util.List<T>

subList

public java.util.List<T> subList(int arg0,
                                 int arg1)

Returns a sub-list in the range specified, loading more results as necessary.

Not supported in ITERATION_ONLY mode.

Specified by:

subList in interface java.util.List<T>

indexOf

public int indexOf(java.lang.Object arg0)

Returns the first index of the object given in the list. Additional results are loaded incrementally as necessary.

Not supported in ITERATION_ONLY mode.

Specified by:

indexOf in interface java.util.List<T>

size

public int size()

Specified by:

size in interface java.util.Collection<T>

Specified by:

size in interface java.util.List<T>

containsAll

public boolean containsAll(java.util.Collection<?> arg0)

Specified by:

containsAll in interface java.util.Collection<T>

Specified by:

containsAll in interface java.util.List<T>

lastIndexOf

public int lastIndexOf(java.lang.Object arg0)

Specified by:

lastIndexOf in interface java.util.List<T>

toArray

public java.lang.Object[] toArray()

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

toArray

public <X> X[] toArray(X[] a)

Specified by:

toArray in interface java.util.Collection<T>

Specified by:

toArray in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator()

Specified by:

listIterator in interface java.util.List<T>

listIterator

public java.util.ListIterator<T> listIterator(int arg0)

Specified by:

listIterator in interface java.util.List<T>

remove

public boolean remove(java.lang.Object arg0)

Specified by:

remove in interface java.util.Collection<T>

Specified by:

remove in interface java.util.List<T>

remove

public T remove(int arg0)

Specified by:

remove in interface java.util.List<T>

removeAll

public boolean removeAll(java.util.Collection<?> arg0)

Specified by:

removeAll in interface java.util.Collection<T>

Specified by:

removeAll in interface java.util.List<T>

retainAll

public boolean retainAll(java.util.Collection<?> arg0)

Specified by:

retainAll in interface java.util.Collection<T>

Specified by:

retainAll in interface java.util.List<T>

set

public T set(int arg0,
             T arg1)

Specified by:

set in interface java.util.List<T>

add

public boolean add(T arg0)

Specified by:

add in interface java.util.Collection<T>

Specified by:

add in interface java.util.List<T>

add

public void add(int arg0,
                T arg1)

Specified by:

add in interface java.util.List<T>

addAll

public boolean addAll(java.util.Collection<? extends T> arg0)

Specified by:

addAll in interface java.util.Collection<T>

Specified by:

addAll in interface java.util.List<T>

addAll

public boolean addAll(int arg0,
                      java.util.Collection<? extends T> arg1)

Specified by:

addAll in interface java.util.List<T>

clear

public void clear()

Specified by:

clear in interface java.util.Collection<T>

Specified by:

clear in interface java.util.List<T>