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

Class ZoneOffsetAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<ZoneOffset>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class ZoneOffsetAttributeConverter
extends Object
implements AttributeConverter<ZoneOffset>

A converter between ZoneOffset and AttributeValue.

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

This can be created via create().

Field Summary

Fields

Modifier and Type	Field	Description
static ZoneOffsetStringConverter	STRING_CONVERTER

Constructor Summary

Constructors

Constructor	Description
ZoneOffsetAttributeConverter()

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

Field Detail

STRING_CONVERTER

public static final ZoneOffsetStringConverter STRING_CONVERTER

Constructor Detail

ZoneOffsetAttributeConverter

public ZoneOffsetAttributeConverter()

Method Detail

create

public static ZoneOffsetAttributeConverter create()

type

public EnhancedType<ZoneOffset> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<ZoneOffset>

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

transformFrom

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

transformTo

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