com.amazonaws.mobileconnectors.dynamodbv2.document.datatype

Class Document

java.lang.Object

com.amazonaws.mobileconnectors.dynamodbv2.document.datatype.DynamoDBEntry

com.amazonaws.mobileconnectors.dynamodbv2.document.datatype.Document

All Implemented Interfaces:

java.util.Map<java.lang.String,DynamoDBEntry>

public class Document
extends DynamoDBEntry
implements java.util.Map<java.lang.String,DynamoDBEntry>

A collection of attribute key-value pairs that defines an item in DynamoDB.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Document() Constructor.
Document(java.util.Map<java.lang.String,DynamoDBEntry> values) Constructor.

Method Summary

Modifier and Type	Method and Description
Document	asDocument() Explicitly convert DynamoDBEntry to Document.
void	clear()
void	commit() Commit the new values.
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object paramObject)
com.amazonaws.services.dynamodbv2.model.AttributeValue	convertToAttributeValue() Converts a DynamoDBEntry to AttributeValue
java.util.Set<java.util.Map.Entry<java.lang.String,DynamoDBEntry>>	entrySet()
boolean	equals(java.lang.Object obj)
static Document	fromAttributeMap(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue> attributes) Construct a Document from an attribute key to AttributeValueUpdate value map.
static Document	fromJson(java.lang.String json) Convert a JSON document to Document
DynamoDBEntry	get(java.lang.Object key)
boolean	hasAttributeChanged(java.lang.String attributeName) Returns is the given attribute has changed.
int	hashCode()
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
void	put(java.lang.String key, boolean value) add a bool for an attribute.
DynamoDBEntry	put(java.lang.String key, DynamoDBEntry value)
void	put(java.lang.String key, java.lang.Number value) add a number for an attribute.
<T> void	put(java.lang.String key, java.util.Set<T> set) add a set for a attribute.
void	put(java.lang.String key, java.lang.String value) Attribute accessor, allows getting or setting of an individual attribute.
void	putAll(java.util.Map<? extends java.lang.String,? extends DynamoDBEntry> m)
DynamoDBEntry	remove(java.lang.Object key)
int	size()
java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue>	toAttributeMap() Returns an attribute key to AttributeValue map.
java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate>	toAttributeUpdateMap(boolean changeAttributesOnly) Returns an attribute key to AttributeValueUpdate value map.
static java.lang.String	toJson(Document document) Converts a Document to JSON String.
static java.lang.String	toJson(Document document, boolean prettyPrint) Converts a Document to JSON String with an optional pretty print.
java.util.Collection<DynamoDBEntry>	values()
<T> Document	withSet(java.lang.String key, java.util.Set<T> set) Fluent Api add a set for a attribute.
Document	withString(java.lang.String key, java.lang.String value) Fluent Api to add a string value for a attribute.

Methods inherited from class com.amazonaws.mobileconnectors.dynamodbv2.document.datatype.DynamoDBEntry

asBoolean, asByteBuffer, asDouble, asDynamoDBList, asFloat, asInt, asLong, asNumber, asPrimitive, asPrimitiveList, asString, convertToAttributeUpdateValue, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Document

public Document()

Constructor.

Document

public Document(java.util.Map<java.lang.String,DynamoDBEntry> values)

Constructor.

Parameters:

values - attribute key-value pair

Method Detail

put

public DynamoDBEntry put(java.lang.String key,
                         DynamoDBEntry value)

Specified by:

put in interface java.util.Map<java.lang.String,DynamoDBEntry>

containsKey

public boolean containsKey(java.lang.Object key)

Specified by:

containsKey in interface java.util.Map<java.lang.String,DynamoDBEntry>

get

public DynamoDBEntry get(java.lang.Object key)

Specified by:

get in interface java.util.Map<java.lang.String,DynamoDBEntry>

remove

public DynamoDBEntry remove(java.lang.Object key)

Specified by:

remove in interface java.util.Map<java.lang.String,DynamoDBEntry>

keySet

public java.util.Set<java.lang.String> keySet()

Specified by:

keySet in interface java.util.Map<java.lang.String,DynamoDBEntry>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,DynamoDBEntry>> entrySet()

Specified by:

entrySet in interface java.util.Map<java.lang.String,DynamoDBEntry>

size

public int size()

Specified by:

size in interface java.util.Map<java.lang.String,DynamoDBEntry>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface java.util.Map<java.lang.String,DynamoDBEntry>

containsValue

public boolean containsValue(java.lang.Object paramObject)

Specified by:

containsValue in interface java.util.Map<java.lang.String,DynamoDBEntry>

putAll

public void putAll(java.util.Map<? extends java.lang.String,? extends DynamoDBEntry> m)

Specified by:

putAll in interface java.util.Map<java.lang.String,DynamoDBEntry>

clear

public void clear()

Specified by:

clear in interface java.util.Map<java.lang.String,DynamoDBEntry>

values

public java.util.Collection<DynamoDBEntry> values()

Specified by:

values in interface java.util.Map<java.lang.String,DynamoDBEntry>

fromJson

public static Document fromJson(java.lang.String json)

Convert a JSON document to Document

Parameters:

json - the json string.

Returns:

Document

toJson

public static java.lang.String toJson(Document document)
                               throws java.io.IOException

Converts a Document to JSON String.

Parameters:

document - the Document.

Returns:

the JSON string.

Throws:

java.io.IOException - in case there is error reading the JSON.

toJson

public static java.lang.String toJson(Document document,
                                      boolean prettyPrint)
                               throws java.io.IOException

Converts a Document to JSON String with an optional pretty print.

Parameters:

document - the Document.

prettyPrint - optionally pretty print.

Returns:

the JSON string.

Throws:

java.io.IOException - in case there is error reading the JSON.

convertToAttributeValue

public com.amazonaws.services.dynamodbv2.model.AttributeValue convertToAttributeValue()

Description copied from class: DynamoDBEntry

Converts a DynamoDBEntry to AttributeValue

Specified by:

convertToAttributeValue in class DynamoDBEntry

Returns:

AttributeValue.

toAttributeMap

public java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue> toAttributeMap()

Returns an attribute key to AttributeValue map.

Returns:

an attribute key to AttributeValue map.

toAttributeUpdateMap

public java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValueUpdate> toAttributeUpdateMap(boolean changeAttributesOnly)

Returns an attribute key to AttributeValueUpdate value map.

Parameters:

changeAttributesOnly - bool value indicating to return only changed attributes.

Returns:

an attribute key to AttributeValueUpdate map.

fromAttributeMap

public static Document fromAttributeMap(java.util.Map<java.lang.String,com.amazonaws.services.dynamodbv2.model.AttributeValue> attributes)

Construct a Document from an attribute key to AttributeValueUpdate value map.

Parameters:

attributes - an attribute key to AttributeValueUpdate value map.

Returns:

Document.

hasAttributeChanged

public boolean hasAttributeChanged(java.lang.String attributeName)

Returns is the given attribute has changed.

Parameters:

attributeName - the name of the attribute.

Returns:

true if the attribute value has changed.

put

public void put(java.lang.String key,
                java.lang.String value)

Attribute accessor, allows getting or setting of an individual attribute.

Parameters:

key - Name of the attribute.

value - Current value of the attribute.

withString

public Document withString(java.lang.String key,
                           java.lang.String value)

Fluent Api to add a string value for a attribute.

Parameters:

key - the attribute name.

value - the attribute value.

Returns:

the current instance of Document.

put

public <T> void put(java.lang.String key,
                    java.util.Set<T> set)

add a set for a attribute.

Type Parameters:

T - the type of set.

Parameters:

key - the attribute name.

set - a typed set.

withSet

public <T> Document withSet(java.lang.String key,
                            java.util.Set<T> set)

Fluent Api add a set for a attribute.

Type Parameters:

T - the type of the set.

Parameters:

key - the attribute name.

set - the type of set.

Returns:

the current instance of Document.

put

public void put(java.lang.String key,
                java.lang.Number value)

add a number for an attribute.

Parameters:

key - the attribute name.

value - the attribute value.

put

public void put(java.lang.String key,
                boolean value)

add a bool for an attribute.

Parameters:

key - the attribute name.

value - the attribute value.

asDocument

public Document asDocument()

Description copied from class: DynamoDBEntry

Explicitly convert DynamoDBEntry to Document.

Overrides:

asDocument in class DynamoDBEntry

Returns:

Document.

commit

public void commit()

Commit the new values.

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface java.util.Map<java.lang.String,DynamoDBEntry>

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface java.util.Map<java.lang.String,DynamoDBEntry>

Overrides:

hashCode in class java.lang.Object