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 betweenLocalDateTimeandAttributeValue.This stores and reads values in DynamoDB as a string.
Values are stored with nanosecond precision.
LocalDateTimes are stored in the official
LocalDateTimeformat "[-]YYYY-MM-DDTHH:II:SS[.NNNNNNNNN]", where:- Y is a year between
Year.MIN_VALUEandYear.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.
LocalDateTimefor more details on the serialization format.This is format-compatible with the
LocalDateAttributeConverter, allowing values stored asLocalDateto be retrieved asLocalDateTimes. The time associated with a value stored as aLocalDateis 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
Constructors Constructor Description LocalDateTimeAttributeConverter()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeValueTypeattributeValueType()TheAttributeValueTypethat a converter stores and reads values from DynamoDB via theAttributeValueclass.static LocalDateTimeAttributeConvertercreate()AttributeValuetransformFrom(LocalDateTime input)Convert the provided Java object into anAttributeValue.LocalDateTimetransformTo(AttributeValue input)Convert the providedAttributeValueinto a Java object.EnhancedType<LocalDateTime>type()The type supported by this converter.
-
-
-
Method Detail
-
create
public static LocalDateTimeAttributeConverter create()
-
type
public EnhancedType<LocalDateTime> type()
Description copied from interface:AttributeConverterThe type supported by this converter.- Specified by:
typein interfaceAttributeConverter<LocalDateTime>
-
attributeValueType
public AttributeValueType attributeValueType()
Description copied from interface:AttributeConverterTheAttributeValueTypethat a converter stores and reads values from DynamoDB via theAttributeValueclass.- Specified by:
attributeValueTypein interfaceAttributeConverter<LocalDateTime>
-
transformFrom
public AttributeValue transformFrom(LocalDateTime input)
Description copied from interface:AttributeConverterConvert the provided Java object into anAttributeValue. This will raise aRuntimeExceptionif 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:
transformFromin interfaceAttributeConverter<LocalDateTime>
-
transformTo
public LocalDateTime transformTo(AttributeValue input)
Description copied from interface:AttributeConverterConvert the providedAttributeValueinto a Java object. This will raise aRuntimeExceptionif 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:
transformToin interfaceAttributeConverter<LocalDateTime>
-
-