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

Class PeriodAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Period>

@ThreadSafe
 @Immutable
public final class PeriodAttributeConverter
extends Object
implements AttributeConverter<Period>

A converter between Period and AttributeValue.

This stores and reads values in DynamoDB as a string, according to the format of Period.parse(CharSequence) and Period.toString().

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 PeriodAttributeConverter	create()
AttributeValue	transformFrom(Period input) Convert the provided Java object into an AttributeValue.
Period	transformTo(AttributeValue input) Convert the provided AttributeValue into a Java object.
EnhancedType<Period>	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 PeriodAttributeConverter create()

type

public EnhancedType<Period> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Period>

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

transformFrom

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

transformTo

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