Package software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute

Class DocumentAttributeConverter<T>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.DocumentAttributeConverter<T>

All Implemented Interfaces:

AttributeConverter<T>

@SdkInternalApi
public class DocumentAttributeConverter<T>
extends Object
implements AttributeConverter<T>

AttributeConverter for converting nested table schemas

Method Summary

Modifier and Type	Method	Description
AttributeValueType	attributeValueType()	The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static <T> DocumentAttributeConverter<T>	create(TableSchema<T> tableSchema, EnhancedType<T> enhancedType)
AttributeValue	transformFrom(T input)	Convert the provided Java object into an AttributeValue.
T	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<T>	type()	The type supported by this converter.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T> DocumentAttributeConverter<T> create(TableSchema<T> tableSchema,
                                                       EnhancedType<T> enhancedType)

transformFrom

public AttributeValue transformFrom(T input)

Description copied from interface: AttributeConverter

Convert the provided Java object into an AttributeValue. This will raise a RuntimeException if the conversion fails, or the input is null.

Example:

 
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformFrom(Instant.EPOCH),
              EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue());
 
 

Specified by:

transformFrom in interface AttributeConverter<T>

transformTo

public T transformTo(AttributeValue input)

Description copied from interface: AttributeConverter

Convert the provided AttributeValue into a Java object. This will raise a RuntimeException if the conversion fails, or the input is null.

 Example:
 
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformTo(EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue()),
              Instant.EPOCH);
 
 

Specified by:

transformTo in interface AttributeConverter<T>

attributeValueType

public AttributeValueType attributeValueType()

Description copied from interface: AttributeConverter

The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.

Specified by:

attributeValueType in interface AttributeConverter<T>

type

public EnhancedType<T> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<T>