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

Class DurationAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Duration>

@ThreadSafe
 @Immutable
public final class DurationAttributeConverter
extends Object
implements AttributeConverter<Duration>

A converter between Duration and AttributeValue.

This stores and reads values in DynamoDB as a number, so that they can be sorted numerically as part of a sort key.

Durations are stored in the format "[-]X[.YYYYYYYYY]", where X is the number of seconds in the duration, and Y is the number of nanoseconds in the duration, left padded with zeroes to a length of 9. The Y and decimal point may be excluded for durations that are of whole seconds. The duration may be preceded by a - to indicate a negative duration.

Examples:

• Duration.ofDays(1) is stored as ItemAttributeValueMapper.fromNumber("86400")
• Duration.ofSeconds(9) is stored as ItemAttributeValueMapper.fromNumber("9")
• Duration.ofSeconds(-9) is stored as ItemAttributeValueMapper.fromNumber("-9")
• Duration.ofNanos(1_234_567_890) is stored as ItemAttributeValueMapper.fromNumber("1.234567890")
• Duration.ofMillis(1) is stored as ItemAttributeValueMapper.fromNumber("0.001000000")
• Duration.ofNanos(1) is stored as ItemAttributeValueMapper.fromNumber("0.000000001")
• Duration.ofNanos(-1) is stored as ItemAttributeValueMapper.fromNumber("-0.000000001")

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

type

public EnhancedType<Duration> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Duration>

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

transformFrom

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

transformTo

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