software.amazon.awssdk.enhanced.dynamodb.model

Class Page<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.model.Page<T>

Type Parameters:

T - The modelled type of the object that has been read.

@ThreadSafe
public final class Page<T>
extends Object

An immutable object that holds a page of queried or scanned results from DynamoDb.

Contains a reference to the last evaluated key for the current page; see lastEvaluatedKey() for more information.

Method Summary

Modifier and Type	Method and Description
static <T> Page<T>	create(List<T> items) Static constructor for this object that sets a null 'lastEvaluatedKey' which indicates this is the final page of results.
static <T> Page<T>	create(List<T> items, Map<String,AttributeValue> lastEvaluatedKey) Static constructor for this object.
boolean	equals(Object o)
int	hashCode()
List<T>	items() Returns a page of mapped objects that represent records from a database query or scan.
Map<String,AttributeValue>	lastEvaluatedKey() Returns the 'lastEvaluatedKey' that DynamoDb returned from the last page query or scan.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

create

public static <T> Page<T> create(List<T> items,
                                 Map<String,AttributeValue> lastEvaluatedKey)

Static constructor for this object.

Type Parameters:

T - The modelled type of the object that has been read.

Parameters:

items - A list of items to store for the page.

lastEvaluatedKey - A 'lastEvaluatedKey' to store for the page.

Returns:

A newly constructed Page object.

create

public static <T> Page<T> create(List<T> items)

Static constructor for this object that sets a null 'lastEvaluatedKey' which indicates this is the final page of results.

Type Parameters:

T - The modelled type of the object that has been read.

Parameters:

items - A list of items to store for the page.

Returns:

A newly constructed Page object.

items

public List<T> items()

Returns a page of mapped objects that represent records from a database query or scan.

Returns:

A list of mapped objects.

lastEvaluatedKey

public Map<String,AttributeValue> lastEvaluatedKey()

Returns the 'lastEvaluatedKey' that DynamoDb returned from the last page query or scan. This key can be used to continue the query or scan if passed into a request.

Returns:

The 'lastEvaluatedKey' from the last query or scan operation or null if the no more pages are available.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object