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 betweenLocalDateandAttributeValue.This stores and reads values in DynamoDB as a String.
LocalDates are stored in the official
LocalDateformat "[-]YYYY-MM-DD", 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
LocalDatefor more details on the serialization format.This is unidirectional format-compatible with the
LocalDateTimeAttributeConverter, allowing values stored asLocalDateto be retrieved asLocalDateTimes.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
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 LocalDateAttributeConvertercreate()AttributeValuetransformFrom(LocalDate input)Convert the provided Java object into anAttributeValue.LocalDatetransformTo(AttributeValue input)Convert the providedAttributeValueinto a Java object.EnhancedType<LocalDate>type()The type supported by this converter.
-
-
-
Method Detail
-
create
public static LocalDateAttributeConverter create()
-
type
public EnhancedType<LocalDate> type()
Description copied from interface:AttributeConverterThe type supported by this converter.- Specified by:
typein interfaceAttributeConverter<LocalDate>
-
attributeValueType
public AttributeValueType attributeValueType()
Description copied from interface:AttributeConverterTheAttributeValueTypethat a converter stores and reads values from DynamoDB via theAttributeValueclass.- Specified by:
attributeValueTypein interfaceAttributeConverter<LocalDate>
-
transformFrom
public AttributeValue transformFrom(LocalDate 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<LocalDate>
-
transformTo
public LocalDate 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<LocalDate>
-
-