Class MonthDayAttributeConverter
java.lang.Object
software.amazon.awssdk.enhanced.dynamodb.internal.converter.attribute.MonthDayAttributeConverter
- All Implemented Interfaces:
AttributeConverter<MonthDay>
@ThreadSafe
@Immutable
public final class MonthDayAttributeConverter
extends Object
implements AttributeConverter<MonthDay>
A converter between
MonthDay
and AttributeValue
.
This stores and reads values in DynamoDB as a String.
MonthDays are stored in the official MonthDay
format "--MM-DD", where:
- M is a 2-character, zero-prefixed month between 01 and 12
- D is a 2-character, zero-prefixed day between 01 and 31
MonthDay
for more details on the serialization format.
This serialization is lexicographically orderable.
Examples:
MonthDay.of(5, 21)
is stored as as an AttributeValue with the String "--05-21"MonthDay.of(12, 1)
is stored as as an AttributeValue with the String "--12-01"
This can be created via create()
.
-
Method Summary
Modifier and TypeMethodDescriptionTheAttributeValueType
that a converter stores and reads values from DynamoDB via theAttributeValue
class.static MonthDayAttributeConverter
create()
transformFrom
(MonthDay 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.
-
Method Details
-
create
-
type
Description copied from interface:AttributeConverter
The type supported by this converter.- Specified by:
type
in interfaceAttributeConverter<MonthDay>
-
attributeValueType
Description copied from interface:AttributeConverter
TheAttributeValueType
that a converter stores and reads values from DynamoDB via theAttributeValue
class.- Specified by:
attributeValueType
in interfaceAttributeConverter<MonthDay>
-
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<MonthDay>
-
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<MonthDay>
-