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

Class OffsetDateTimeAsStringAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<OffsetDateTime>

@ThreadSafe
 @Immutable
public final class OffsetDateTimeAsStringAttributeConverter
extends Object
implements AttributeConverter<OffsetDateTime>

A converter between OffsetDateTime and AttributeValue.

This stores values in DynamoDB as a string.

Values are stored in ISO-8601 format, with nanosecond precision. If the offset has seconds then they will also be included, even though this is not part of the ISO-8601 standard. For full ISO-8601 compliance, ensure your OffsetDateTimes do not have offsets at the precision level of seconds.

Examples:

• OffsetDateTime.MIN is stored as ItemAttributeValueMapper.fromString("-999999999-01-01T00:00:00+18:00")
• OffsetDateTime.MAX is stored as ItemAttributeValueMapper.fromString("+999999999-12-31T23:59:59.999999999-18:00")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).plusSeconds(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:01Z")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).minusSeconds(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59Z")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).plusMillis(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:00.001Z")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).minusMillis(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59.999Z")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).plusNanos(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:00.000000001Z")
• Instant.EPOCH.atOffset(ZoneOffset.UTC).minusNanos(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59.999999999Z")

This converter can read any values written by itself, InstantAsIntegerAttributeConverter, InstantAsStringAttributeConverter, or ZonedDateTimeAsStringAttributeConverter. Values written by Instant converters are treated as if they are in the UTC time zone (and an offset of 0 seconds will be returned).

This can be created via create().

Constructor Summary

Constructors

Constructor and Description
OffsetDateTimeAsStringAttributeConverter()

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

Constructor Detail

OffsetDateTimeAsStringAttributeConverter

public OffsetDateTimeAsStringAttributeConverter()

Method Detail

create

public static OffsetDateTimeAsStringAttributeConverter create()

type

public EnhancedType<OffsetDateTime> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<OffsetDateTime>

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

transformFrom

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

transformTo

public OffsetDateTime 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:
 {@code
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformTo(EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue()),
              Instant.EPOCH);
 

Specified by:

transformTo in interface AttributeConverter<OffsetDateTime>