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

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:

1. M is a 2-character, zero-prefixed month between 01 and 12
2. D is a 2-character, zero-prefixed day between 01 and 31

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

type

public EnhancedType<MonthDay> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<MonthDay>

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

transformFrom

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

transformTo

public MonthDay 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<MonthDay>