Class StringAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<String>

@ThreadSafe
@Immutable
public final class StringAttributeConverter
extends Object
implements AttributeConverter<String>

A converter between String and AttributeValue.

This stores values in DynamoDB as a string.

This supports reading any DynamoDB attribute type into a string type, so it is very useful for logging information stored in DynamoDB.

Constructor Summary

Constructors

Constructor	Description
StringAttributeConverter()

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

Methods inherited from class java.lang.Object

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

Constructor Details

StringAttributeConverter

public StringAttributeConverter()

Method Details

create

public static StringAttributeConverter create()

type

public EnhancedType<String> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<String>

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

transformFrom

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

transformTo

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