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

Class CharSequenceAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<CharSequence>

@ThreadSafe
 @Immutable
public final class CharSequenceAttributeConverter
extends Object
implements AttributeConverter<CharSequence>

A converter between CharSequence and AttributeValue.

This stores values in DynamoDB as a string.

This supports reading every string value supported by DynamoDB, making it fully compatible with custom converters as well as internal converters (e.g. StringAttributeConverter).

This can be created via create().

Method Summary

Modifier and Type	Method and Description
AttributeValueType	attributeValueType() The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static CharSequenceAttributeConverter	create()
AttributeValue	transformFrom(CharSequence input) Convert the provided Java object into an AttributeValue.
CharSequence	transformTo(AttributeValue input) Convert the provided AttributeValue into a Java object.
EnhancedType<CharSequence>	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 CharSequenceAttributeConverter create()

type

public EnhancedType<CharSequence> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<CharSequence>

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

transformFrom

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

transformTo

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