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

Class InstantAsStringAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Instant>

@ThreadSafe
 @Immutable
public final class InstantAsStringAttributeConverter
extends Object
implements AttributeConverter<Instant>

A converter between Instant and AttributeValue.

This stores values in DynamoDB as a string. If a number is desired (for sorting purposes), use InstantAsIntegerAttributeConverter instead.

Values are stored in ISO-8601 format, with nanosecond precision and a time zone of UTC.

Examples:

• Instant.EPOCH.plusSeconds(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:01Z")
• Instant.EPOCH.minusSeconds(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59Z")
• Instant.EPOCH.plusMillis(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:00.001Z")
• Instant.EPOCH.minusMillis(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59.999Z")
• Instant.EPOCH.plusNanos(1) is stored as ItemAttributeValueMapper.fromString("1970-01-01T00:00:00.000000001Z")
• Instant.EPOCH.minusNanos(1) is stored as ItemAttributeValueMapper.fromString("1969-12-31T23:59:59.999999999Z")

This converter can read any values written by itself, InstantAsIntegerAttributeConverter, OffsetDateTimeAsStringAttributeConverter or ZonedDateTimeAsStringAttributeConverter. Offset and zoned times will be automatically converted to the equivalent Instant based on the time zone information in the record (e.g. ItemAttributeValueMapper.fromString("1970-01-01T00:00:00+01:00") will be converted to Instant.EPOCH.minus(1, ChronoUnit.HOURS)).

This can be created via create().

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

type

public EnhancedType<Instant> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Instant>

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

transformFrom

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

transformTo

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