Class OffsetDateTimeAsStringAttributeConverter
- All Implemented Interfaces:
AttributeConverter<OffsetDateTime>
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 OffsetDateTime
s do
not have offsets at the precision level of seconds.
Examples:
OffsetDateTime.MIN
is stored as an AttributeValue with the String "-999999999-01-01T00:00+18:00"OffsetDateTime.MAX
is stored as an AttributeValue with the String "+999999999-12-31T23:59:59.999999999-18:00"Instant.EPOCH.atOffset(ZoneOffset.UTC).plusSeconds(1)
is stored as an AttributeValue with the String "1970-01-01T00:00:01Z"Instant.EPOCH.atOffset(ZoneOffset.UTC).minusSeconds(1)
is stored as an AttributeValue with the String "1969-12-31T23:59:59Z"Instant.EPOCH.atOffset(ZoneOffset.UTC).plusMillis(1)
is stored as an AttributeValue with the String "1970-01-01T00:00:00.001Z"Instant.EPOCH.atOffset(ZoneOffset.UTC).minusMillis(1)
is stored as an AttributeValue with the String "1969-12-31T23:59:59.999Z"Instant.EPOCH.atOffset(ZoneOffset.UTC).plusNanos(1)
is stored as an AttributeValue with the String "1970-01-01T00:00:00.000000001Z"Instant.EPOCH.atOffset(ZoneOffset.UTC).minusNanos(1)
is stored as an AttributeValue with the String "1969-12-31T23:59:59.999999999Z"
OffsetDateTime
for more details on the serialization format.
This converter can read any values written by itself or InstantAsStringAttributeConverter
,
and values without a time zone named written byZonedDateTimeAsStringAttributeConverter
.
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 serialization is lexicographically orderable when the year is not negative.
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
(OffsetDateTime 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
-
OffsetDateTimeAsStringAttributeConverter
public OffsetDateTimeAsStringAttributeConverter()
-
-
Method Details
-
create
-
type
Description copied from interface:AttributeConverter
The type supported by this converter.- Specified by:
type
in interfaceAttributeConverter<OffsetDateTime>
-
attributeValueType
Description copied from interface:AttributeConverter
TheAttributeValueType
that a converter stores and reads values from DynamoDB via theAttributeValue
class.- Specified by:
attributeValueType
in interfaceAttributeConverter<OffsetDateTime>
-
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<OffsetDateTime>
-
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<OffsetDateTime>
-