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

Class OptionalDoubleAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<OptionalDouble>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class OptionalDoubleAttributeConverter
extends Object
implements AttributeConverter<OptionalDouble>

A converter between OptionalDouble and AttributeValue.

This stores values in DynamoDB as a number.

This supports converting numbers stored in DynamoDB into a double-precision floating point number, within the range Double.MIN_VALUE, Double.MAX_VALUE. Null values are converted to OptionalDouble.empty(). For less precision or smaller values, consider using OptionalAttributeConverter along with a Float type. For greater precision or larger values, consider using OptionalAttributeConverter along with a BigDecimal type.

If values are known to be whole numbers, it is recommended to use a perfect-precision whole number representation like those provided by OptionalIntAttributeConverter, OptionalLongAttributeConverter, or a OptionalAttributeConverter along with a BigInteger type.

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

type

public EnhancedType<OptionalDouble> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<OptionalDouble>

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

transformFrom

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

transformTo

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