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 string.
Values are stored with nanosecond precision.
LocalDateTimes are stored in the official LocalDateTime
format "[-]YYYY-MM-DDTHH:II:SS[.NNNNNNNNN]", where:
- Y is a year between
Year.MIN_VALUE
andYear.MAX_VALUE
(prefixed with - if it is negative) - M is a 2-character, zero-prefixed month between 01 and 12
- D is a 2-character, zero-prefixed day between 01 and 31
- H is a 2-character, zero-prefixed hour between 00 and 23
- I is a 2-character, zero-prefixed minute between 00 and 59
- S is a 2-character, zero-prefixed second between 00 and 59
- 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.
LocalDateTime
for more details on the serialization format.
This is format-compatible with the LocalDateAttributeConverter
, allowing values stored as LocalDate
to be
retrieved as LocalDateTime
s. The time associated with a value stored as a LocalDate
is the
beginning of the day (midnight).
This serialization is lexicographically orderable when the year is not negative.
Examples:LocalDateTime.of(1988, 5, 21, 0, 0, 0)
is stored as an AttributeValue with the String "1988-05-21T00:00"LocalDateTime.of(-1988, 5, 21, 0, 0, 0)
is stored as an AttributeValue with the String "-1988-05-21T00:00"LocalDateTime.of(1988, 5, 21, 0, 0, 0).plusSeconds(1)
is stored as an AttributeValue with the String "1988-05-21T00:00:01"LocalDateTime.of(1988, 5, 21, 0, 0, 0).minusSeconds(1)
is stored as an AttributeValue with the String "1988-05-20T23:59:59"LocalDateTime.of(1988, 5, 21, 0, 0, 0).plusNanos(1)
is stored as an AttributeValue with the String "1988-05-21T00:00:00.0000000001"LocalDateTime.of(1988, 5, 21, 0, 0, 0).minusNanos(1)
is stored as an AttributeValue with the String "1988-05-20T23:59:59.999999999"
This can be created via create()
.
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionTheAttributeValueType
that a converter stores and reads values from DynamoDB via theAttributeValue
class.create()
transformFrom
(LocalDateTime input) Convert the provided Java object into anAttributeValue
.transformTo
(AttributeValue input) Convert the providedAttributeValue
into a Java object.type()
The type supported by this converter.
-
Constructor Details
-
LocalDateTimeAttributeConverter
public LocalDateTimeAttributeConverter()
-
-
Method Details
-
create
-
type
Description copied from interface:AttributeConverter
The type supported by this converter.- Specified by:
type
in interfaceAttributeConverter<LocalDateTime>
-
attributeValueType
Description copied from interface:AttributeConverter
TheAttributeValueType
that a converter stores and reads values from DynamoDB via theAttributeValue
class.- Specified by:
attributeValueType
in interfaceAttributeConverter<LocalDateTime>
-
transformFrom
Description copied from interface:AttributeConverter
Convert the provided Java object into anAttributeValue
. This will raise aRuntimeException
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 interfaceAttributeConverter<LocalDateTime>
-
transformTo
Description copied from interface:AttributeConverter
Convert the providedAttributeValue
into a Java object. This will raise aRuntimeException
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 interfaceAttributeConverter<LocalDateTime>
-