Class ZoneIdAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<ZoneId>

@ThreadSafe
@Immutable
public final class ZoneIdAttributeConverter
extends Object
implements AttributeConverter<ZoneId>

A converter between ZoneId and AttributeValue.

This stores and reads values in DynamoDB as a string using ZoneId.toString() and ZoneId.of(String).

This can be created via create().

Field Summary

Fields

Modifier and Type	Field	Description
static final ZoneIdStringConverter	STRING_CONVERTER

Constructor Summary

Constructors

Constructor	Description
ZoneIdAttributeConverter()

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 ZoneIdAttributeConverter	create()
AttributeValue	transformFrom(ZoneId input)	Convert the provided Java object into an AttributeValue.
ZoneId	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<ZoneId>	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 ZoneIdStringConverter STRING_CONVERTER

Constructor Details

ZoneIdAttributeConverter

public ZoneIdAttributeConverter()

Method Details

create

public static ZoneIdAttributeConverter create()

type

public EnhancedType<ZoneId> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<ZoneId>

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

transformFrom

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

transformTo

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