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

Class LocalDateTimeAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<LocalDateTime>

@ThreadSafe
 @Immutable
public final class LocalDateTimeAttributeConverter
extends Object
implements AttributeConverter<LocalDateTime>

A converter between LocalDateTime and AttributeValue.

This stores and reads values in DynamoDB as a number, so that they can be sorted numerically as part of a sort key.

LocalDateTimes are stored in the format "[-]YYYYMMDDHHIISS[.NNNNNNNNN]", where:

1. Y is a year between Year.MIN_VALUE and Year.MAX_VALUE (prefixed with - if it is negative)
2. M is a 2-character, zero-prefixed month between 01 and 12
3. D is a 2-character, zero-prefixed day between 01 and 31
4. H is a 2-character, zero-prefixed hour between 00 and 23
5. I is a 2-character, zero-prefixed minute between 00 and 59
6. S is a 2-character, zero-prefixed second between 00 and 59
7. N is a 9-character, zero-prefixed nanosecond between 000,000,000 and 999,999,999. The . and N may be excluded if N is 0.

This is format-compatible with the LocalDateAttributeConverter, allowing values stored as LocalDate to be retrieved as LocalDateTimes and vice-versa. The time associated with a value stored as a LocalDate is the beginning of the day (midnight).

Examples:

• LocalDateTime.of(1988, 5, 21, 0, 0, 0) is stored as ItemAttributeValueMapper.fromNumber("19880521000000")
• LocalDateTime.of(-1988, 5, 21, 0, 0, 0) is stored as ItemAttributeValueMapper.fromNumber("-19880521000000")
• LocalDateTime.of(1988, 5, 21, 0, 0, 0).plusSeconds(1) is stored as ItemAttributeValueMapper.fromNumber("19880521000001")
• LocalDateTime.of(1988, 5, 21, 0, 0, 0).minusSeconds(1) is stored as ItemAttributeValueMapper.fromNumber("19880520235959")
• LocalDateTime.of(1988, 5, 21, 0, 0, 0).plusNanos(1) is stored as ItemAttributeValueMapper.fromNumber("19880521000000.0000000001")
• LocalDateTime.of(1988, 5, 21, 0, 0, 0).minusNanos(1) is stored as ItemAttributeValueMapper.fromNumber("19880520235959.999999999")

This can be created via create().

Constructor Summary

Constructors

Constructor and Description
LocalDateTimeAttributeConverter()

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

LocalDateTimeAttributeConverter

public LocalDateTimeAttributeConverter()

Method Detail

create

public static LocalDateTimeAttributeConverter create()

type

public EnhancedType<LocalDateTime> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<LocalDateTime>

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

transformFrom

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

transformTo

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