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

Class LocalDateAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<LocalDate>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class LocalDateAttributeConverter
extends Object
implements AttributeConverter<LocalDate>

A converter between LocalDate and AttributeValue.

This stores and reads values in DynamoDB as a String.

LocalDates are stored in the official LocalDate format "[-]YYYY-MM-DD", 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

See LocalDate for more details on the serialization format.

This is unidirectional format-compatible with the LocalDateTimeAttributeConverter, allowing values stored as LocalDate to be retrieved as LocalDateTimes.

This serialization is lexicographically orderable when the year is not negative.

Examples:

• LocalDate.of(1988, 5, 21) is stored as as an AttributeValue with the String "1988-05-21"
• LocalDate.of(0, 1, 1) is stored as as an AttributeValue with the String "0000-01-01"

This can be created via create().

Method Summary

Modifier and Type	Method	Description
AttributeValueType	attributeValueType()	The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static LocalDateAttributeConverter	create()
AttributeValue	transformFrom(LocalDate input)	Convert the provided Java object into an AttributeValue.
LocalDate	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<LocalDate>	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 LocalDateAttributeConverter create()

type

public EnhancedType<LocalDate> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<LocalDate>

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

transformFrom

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

transformTo

public LocalDate 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:
 
 InstantAsStringAttributeConverter converter = InstantAsStringAttributeConverter.create();
 assertEquals(converter.transformTo(EnhancedAttributeValue.fromString("1970-01-01T00:00:00Z").toAttributeValue()),
              Instant.EPOCH);
 
 

Specified by:

transformTo in interface AttributeConverter<LocalDate>