Class JsonItemAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<JsonNode>

@ThreadSafe
@Immutable
public final class JsonItemAttributeConverter
extends Object
implements AttributeConverter<JsonNode>

An Internal converter between JsonNode and AttributeValue.

This converts the Attribute Value read from the DDB to JsonNode.

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 JsonItemAttributeConverter	create()
AttributeValue	transformFrom(JsonNode input)	Convert the provided Java object into an AttributeValue.
JsonNode	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<JsonNode>	type()	The type supported by this converter.

Methods inherited from class java.lang.Object

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

Method Details

create

public static JsonItemAttributeConverter create()

type

public EnhancedType<JsonNode> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<JsonNode>

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<JsonNode>

transformFrom

public AttributeValue transformFrom(JsonNode 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<JsonNode>

transformTo

public JsonNode 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<JsonNode>