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

Class LocaleAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Locale>

@ThreadSafe
@Immutable
public final class LocaleAttributeConverter
extends Object
implements AttributeConverter<Locale>

A converter between Locale and AttributeValue.

This stores and reads values in DynamoDB as a string, according to the format of Locale.forLanguageTag(String) and Locale.toLanguageTag().

Field Summary

Fields

Modifier and Type	Field	Description
static final LocaleStringConverter	STRING_CONVERTER

Constructor Summary

Constructors

Constructor	Description
LocaleAttributeConverter()

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

Methods inherited from class java.lang.Object

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

Field Details

STRING_CONVERTER

public static final LocaleStringConverter STRING_CONVERTER

Constructor Details

LocaleAttributeConverter

public LocaleAttributeConverter()

Method Details

create

public static LocaleAttributeConverter create()

type

public EnhancedType<Locale> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Locale>

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

transformFrom

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

transformTo

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