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 betweenLocalTimeandAttributeValue.This stores and reads values in DynamoDB as a String.
LocalTimes are stored in the official
LocalTimeformat "HH:II:SS[.NNNNNNNNN]", where:- H is a 2-character, zero-prefixed hour between 00 and 23
- I is a 2-character, zero-prefixed minute between 00 and 59
- S is a 2-character, zero-prefixed second between 00 and 59
- 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.
LocalTimefor 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeValueTypeattributeValueType()TheAttributeValueTypethat a converter stores and reads values from DynamoDB via theAttributeValueclass.static LocalTimeAttributeConvertercreate()AttributeValuetransformFrom(LocalTime input)Convert the provided Java object into anAttributeValue.LocalTimetransformTo(AttributeValue input)Convert the providedAttributeValueinto a Java object.EnhancedType<LocalTime>type()The type supported by this converter.
-
-
-
Method Detail
-
create
public static LocalTimeAttributeConverter create()
-
type
public EnhancedType<LocalTime> type()
Description copied from interface:AttributeConverterThe type supported by this converter.- Specified by:
typein interfaceAttributeConverter<LocalTime>
-
attributeValueType
public AttributeValueType attributeValueType()
Description copied from interface:AttributeConverterTheAttributeValueTypethat a converter stores and reads values from DynamoDB via theAttributeValueclass.- Specified by:
attributeValueTypein interfaceAttributeConverter<LocalTime>
-
transformFrom
public AttributeValue transformFrom(LocalTime input)
Description copied from interface:AttributeConverterConvert the provided Java object into anAttributeValue. This will raise aRuntimeExceptionif 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:
transformFromin interfaceAttributeConverter<LocalTime>
-
transformTo
public LocalTime transformTo(AttributeValue input)
Description copied from interface:AttributeConverterConvert the providedAttributeValueinto a Java object. This will raise aRuntimeExceptionif 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:
transformToin interfaceAttributeConverter<LocalTime>
-
-