Class LocalTimeAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<LocalTime>

@ThreadSafe
@Immutable
public final class LocalTimeAttributeConverter
extends Object
implements AttributeConverter<LocalTime>

A converter between LocalTime and AttributeValue.

This stores and reads values in DynamoDB as a String.

LocalTimes are stored in the official LocalTime format "HH:II:SS[.NNNNNNNNN]", where:

1. H is a 2-character, zero-prefixed hour between 00 and 23
2. I is a 2-character, zero-prefixed minute between 00 and 59
3. S is a 2-character, zero-prefixed second between 00 and 59
4. N is a 9-character, zero-prefixed nanosecond between 000,000,000 and 999,999,999. The . and N may be excluded if N is 0.

See LocalTime for more details on the serialization format.

This serialization is lexicographically orderable.

Examples:

• LocalTime.of(5, 30, 0) is stored as an AttributeValue with the String "05:30"
• LocalTime.of(5, 30, 0, 1) is stored as an AttributeValue with the String "05:30:00.000000001"

This can be created via create().

Method Summary

Modifier and Type	Method	Description
AttributeValueType	attributeValueType()	The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static LocalTimeAttributeConverter	create()
AttributeValue	transformFrom(LocalTime input)	Convert the provided Java object into an AttributeValue.
LocalTime	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<LocalTime>	type()	The type supported by this converter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static LocalTimeAttributeConverter create()

type

public EnhancedType<LocalTime> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<LocalTime>

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

transformFrom

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

transformTo

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