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

Class CharacterAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Character>, PrimitiveConverter<Character>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class CharacterAttributeConverter
extends Object
implements AttributeConverter<Character>, PrimitiveConverter<Character>

A converter between Character and AttributeValue.

This stores values in DynamoDB as a single-character string.

This only supports reading a single character from DynamoDB. Any string longer than 1 character will cause a RuntimeException during conversion.

This can be created via create().

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

type

public EnhancedType<Character> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Character>

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

transformFrom

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

transformTo

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

primitiveType

public EnhancedType<Character> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Character>