Package software.amazon.awssdk.enhanced.dynamodb.internal.document

Class DefaultEnhancedDocument.DefaultBuilder

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.document.DefaultEnhancedDocument.DefaultBuilder

All Implemented Interfaces:

EnhancedDocument.Builder

Enclosing class:

DefaultEnhancedDocument

public static class DefaultEnhancedDocument.DefaultBuilder
extends Object
implements EnhancedDocument.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultBuilder(DefaultEnhancedDocument enhancedDocument)

Method Summary

Modifier and Type	Method	Description
EnhancedDocument.Builder	addAttributeConverterProvider(AttributeConverterProvider attributeConverterProvider)	Appends collection of attributeConverterProvider to the document builder.
EnhancedDocument.Builder	attributeConverterProviders(List<AttributeConverterProvider> attributeConverterProviders)	Sets the collection of attributeConverterProviders to the document builder.
EnhancedDocument.Builder	attributeConverterProviders(AttributeConverterProvider... attributeConverterProviders)	Sets collection of attributeConverterProviders to the document builder.
EnhancedDocument.Builder	attributeValueMap(Map<String,AttributeValue> attributeValueMap)	Sets the attributes of the document builder to those specified in the provided from a AttributeValue Map, and completely replaces any previously set attributes.
EnhancedDocument	build()	Builds an instance of EnhancedDocument.
EnhancedDocument.Builder	json(String json)	Sets the attributes of the document builder to those specified in the provided JSON string, and completely replaces any previously set attributes.
<T> EnhancedDocument.Builder	put(String attributeName, T value, Class<T> type)	Appends an attribute named attributeName with a value of Class type T.
<T> EnhancedDocument.Builder	put(String attributeName, T value, EnhancedType<T> type)	Appends an attribute named attributeName with a value of type EnhancedType T.
EnhancedDocument.Builder	putBoolean(String attributeName, boolean value)	Use this method when you need to add a boolean value to a document.
EnhancedDocument.Builder	putBytes(String attributeName, SdkBytes value)	Appends an attribute of name attributeName with specified SdkBytes value to the document builder.
EnhancedDocument.Builder	putBytesSet(String attributeName, Set<SdkBytes> values)	Appends an attribute of name attributeName with specified Set of SdkBytes values to the document builder.
EnhancedDocument.Builder	putJson(String attributeName, String json)	Appends an attribute to the document builder with the specified name and value of a JSON document in string format.
<T> EnhancedDocument.Builder	putList(String attributeName, List<T> value, EnhancedType<T> type)	Appends an attribute with the specified name and a list of EnhancedType T type elements to the document builder.
<K, V> EnhancedDocument.Builder	putMap(String attributeName, Map<K,V> value, EnhancedType<K> keyType, EnhancedType<V> valueType)	Appends an attribute with the specified name and a Map containing keys and values of EnhancedType K and V types, respectively, to the document builder.
EnhancedDocument.Builder	putNull(String attributeName)	Appends an attribute of name attributeName with a null value.
EnhancedDocument.Builder	putNumber(String attributeName, Number value)	Appends an attribute of name attributeName with specified Number value to the document builder.
EnhancedDocument.Builder	putNumberSet(String attributeName, Set<Number> values)	Appends an attribute of name attributeName with specified Set of Number values to the document builder.
EnhancedDocument.Builder	putObject(String attributeName, Object value)
EnhancedDocument.Builder	putString(String attributeName, String value)	Appends an attribute of name attributeName with specified String value to the document builder.
EnhancedDocument.Builder	putStringSet(String attributeName, Set<String> values)	Appends an attribute to the document builder with a Set of Strings as its value.
EnhancedDocument.Builder	remove(String attributeName)	Removes a previously appended attribute.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultBuilder

public DefaultBuilder(DefaultEnhancedDocument enhancedDocument)

Method Details

putObject

public EnhancedDocument.Builder putObject(String attributeName,
 Object value)

putString

public EnhancedDocument.Builder putString(String attributeName,
 String value)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with specified String value to the document builder. Use this method when you need to add a string value to a document. If you need to add an attribute with a value of a different type, such as a number or a map, use the appropriate put method instead

Specified by:

putString in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

value - The string value that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putNumber

public EnhancedDocument.Builder putNumber(String attributeName,
 Number value)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with specified Number value to the document builder. Use this method when you need to add a number value to a document. If you need to add an attribute with a value of a different type, such as a string or a map, use the appropriate put method instead

Specified by:

putNumber in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

value - The number value that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putBytes

public EnhancedDocument.Builder putBytes(String attributeName,
 SdkBytes value)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with specified SdkBytes value to the document builder. Use this method when you need to add a binary value to a document. If you need to add an attribute with a value of a different type, such as a string or a map, use the appropriate put method instead

Specified by:

putBytes in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

value - The byte array value that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putBoolean

public EnhancedDocument.Builder putBoolean(String attributeName,
 boolean value)

Description copied from interface: EnhancedDocument.Builder

Use this method when you need to add a boolean value to a document. If you need to add an attribute with a value of a different type, such as a string or a map, use the appropriate put method instead.

Specified by:

putBoolean in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

value - The boolean value that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putNull

public EnhancedDocument.Builder putNull(String attributeName)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with a null value. Use this method is the attribute needs to explicitly set to null in Dynamo DB table.

Specified by:

putNull in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

Returns:

Builder instance to construct a EnhancedDocument

putStringSet

public EnhancedDocument.Builder putStringSet(String attributeName,
 Set<String> values)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute to the document builder with a Set of Strings as its value. This method is intended for use in DynamoDB where attribute values are stored as Sets of Strings.

Specified by:

putStringSet in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

values - Set of String values that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putNumberSet

public EnhancedDocument.Builder putNumberSet(String attributeName,
 Set<Number> values)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with specified Set of Number values to the document builder.

Specified by:

putNumberSet in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

values - Set of Number values that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putBytesSet

public EnhancedDocument.Builder putBytesSet(String attributeName,
 Set<SdkBytes> values)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute of name attributeName with specified Set of SdkBytes values to the document builder.

Specified by:

putBytesSet in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

values - Set of SdkBytes values that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

putList

public <T> EnhancedDocument.Builder putList(String attributeName,
 List<T> value,
 EnhancedType<T> type)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute with the specified name and a list of EnhancedType T type elements to the document builder. Use EnhancedType.of(Class) to specify the class type of the list elements.

For example, to insert a list of String type:

EnhancedDocument.builder().putList(stringList, EnhancedType.of(String.class))

Example for inserting a List of Custom type .

EnhancedDocument.builder().putList(stringList, EnhancedType.of(CustomClass.class));

Note that the AttributeConverterProvider added to the DocumentBuilder should provide the converter for the class T that is to be inserted.

Specified by:

putList in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

value - The list of values that needs to be set.

Returns:

Builder instance to construct a EnhancedDocument

put

public <T> EnhancedDocument.Builder put(String attributeName,
 T value,
 EnhancedType<T> type)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute named attributeName with a value of type EnhancedType T. Use this method to insert attribute values of custom types that have attribute converters defined in a converter provider. Example:

 EnhancedDocument.builder().put("customKey", customValue, EnhancedType.of(CustomClass.class));

Use EnhancedDocument.Builder.putString(String, String) or EnhancedDocument.Builder.putNumber(String, Number) for inserting simple value types of attributes. Use EnhancedDocument.Builder.putList(String, List, EnhancedType) or EnhancedDocument.Builder.putMap(String, Map, EnhancedType, EnhancedType) for inserting collections of attribute values. Note that the attribute converter provider added to the DocumentBuilder must provide the converter for the class T that is to be inserted.

Specified by:

put in interface EnhancedDocument.Builder

Type Parameters:

T - the type of the value to set.

Parameters:

attributeName - the name of the attribute to be added to the document.

value - the value to set.

type - the Enhanced type of the value to set.

Returns:

a builder instance to construct a EnhancedDocument.

put

public <T> EnhancedDocument.Builder put(String attributeName,
 T value,
 Class<T> type)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute named attributeName with a value of Class type T. Use this method to insert attribute values of custom types that have attribute converters defined in a converter provider. Example:

 EnhancedDocument.builder().put("customKey", customValue, CustomClass.class);

Use EnhancedDocument.Builder.putString(String, String) or EnhancedDocument.Builder.putNumber(String, Number) for inserting simple value types of attributes. Use EnhancedDocument.Builder.putList(String, List, EnhancedType) or EnhancedDocument.Builder.putMap(String, Map, EnhancedType, EnhancedType) for inserting collections of attribute values. Note that the attribute converter provider added to the DocumentBuilder must provide the converter for the class T that is to be inserted.

Specified by:

put in interface EnhancedDocument.Builder

Type Parameters:

T - the type of the value to set.

Parameters:

attributeName - the name of the attribute to be added to the document.

value - the value to set.

type - the type of the value to set.

Returns:

a builder instance to construct a EnhancedDocument.

putMap

public <K,
V> EnhancedDocument.Builder putMap(String attributeName,
 Map<K,V> value,
 EnhancedType<K> keyType,
 EnhancedType<V> valueType)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute with the specified name and a Map containing keys and values of EnhancedType K and V types, respectively, to the document builder. Use EnhancedType.of(Class) to specify the class type of the keys and values.

For example, to insert a map with String keys and Long values:

 EnhancedDocument.builder().putMap("stringMap", mapWithStringKeyNumberValue, EnhancedType.of(String.class),
 EnhancedType.of(String.class), EnhancedType.of(Long.class))

For example, to insert a map of String Key and Custom Values:

 EnhancedDocument.builder().putMap("customMap", mapWithStringKeyCustomValue, EnhancedType.of(String.class),
 EnhancedType.of(String.class), EnhancedType.of(Custom.class))

Note that the AttributeConverterProvider added to the DocumentBuilder should provide the converter for the classes K and V that are to be inserted.

Specified by:

putMap in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document

value - The Map of values that needs to be set.

keyType - Enhanced type of Key class

valueType - Enhanced type of Value class.

Returns:

Builder instance to construct a EnhancedDocument

putJson

public EnhancedDocument.Builder putJson(String attributeName,
 String json)

Description copied from interface: EnhancedDocument.Builder

Appends an attribute to the document builder with the specified name and value of a JSON document in string format.

Specified by:

putJson in interface EnhancedDocument.Builder

Parameters:

attributeName - the name of the attribute to be added to the document.

json - JSON document in the form of a string.

Returns:

Builder instance to construct a EnhancedDocument

remove

public EnhancedDocument.Builder remove(String attributeName)

Description copied from interface: EnhancedDocument.Builder

Removes a previously appended attribute. This can be used where a previously added attribute to the Builder is no longer needed.

Specified by:

remove in interface EnhancedDocument.Builder

Parameters:

attributeName - The attribute that needs to be removed.

Returns:

Builder instance to construct a EnhancedDocument

addAttributeConverterProvider

public EnhancedDocument.Builder addAttributeConverterProvider(AttributeConverterProvider attributeConverterProvider)

Description copied from interface: EnhancedDocument.Builder

Appends collection of attributeConverterProvider to the document builder. These AttributeConverterProvider will be used to convert any given key to custom type T. The first matching converter from the given provider will be selected based on the order in which they are added.

Specified by:

addAttributeConverterProvider in interface EnhancedDocument.Builder

Parameters:

attributeConverterProvider - determining the AttributeConverter to use for converting a value.

Returns:

Builder instance to construct a EnhancedDocument

attributeConverterProviders

public EnhancedDocument.Builder attributeConverterProviders(List<AttributeConverterProvider> attributeConverterProviders)

Description copied from interface: EnhancedDocument.Builder

Sets the collection of attributeConverterProviders to the document builder. These AttributeConverterProvider will be used to convert value of any given key to custom type T. The first matching converter from the given provider will be selected based on the order in which they are added.

Specified by:

attributeConverterProviders in interface EnhancedDocument.Builder

Parameters:

attributeConverterProviders - determining the AttributeConverter to use for converting a value.

Returns:

Builder instance to construct a EnhancedDocument

attributeConverterProviders

public EnhancedDocument.Builder attributeConverterProviders(AttributeConverterProvider... attributeConverterProviders)

Description copied from interface: EnhancedDocument.Builder

Sets collection of attributeConverterProviders to the document builder. These AttributeConverterProvider will be used to convert any given key to custom type T. The first matching converter from the given provider will be selected based on the order in which they are added.

Specified by:

attributeConverterProviders in interface EnhancedDocument.Builder

Parameters:

attributeConverterProviders - determining the AttributeConverter to use for converting a value.

Returns:

Builder instance to construct a EnhancedDocument

json

public EnhancedDocument.Builder json(String json)

Description copied from interface: EnhancedDocument.Builder

Sets the attributes of the document builder to those specified in the provided JSON string, and completely replaces any previously set attributes.

Specified by:

json in interface EnhancedDocument.Builder

Parameters:

json - a JSON document represented as a string

Returns:

a builder instance to construct a EnhancedDocument

attributeValueMap

public EnhancedDocument.Builder attributeValueMap(Map<String,AttributeValue> attributeValueMap)

Description copied from interface: EnhancedDocument.Builder

Sets the attributes of the document builder to those specified in the provided from a AttributeValue Map, and completely replaces any previously set attributes.

Specified by:

attributeValueMap in interface EnhancedDocument.Builder

Parameters:

attributeValueMap - - Map with Attributes as String keys and AttributeValue as Value.

Returns:

Builder instance to construct a EnhancedDocument

build

public EnhancedDocument build()

Description copied from interface: EnhancedDocument.Builder

Builds an instance of EnhancedDocument.

Specified by:

build in interface EnhancedDocument.Builder

Returns:

instance of EnhancedDocument implementation.