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

Class DoubleAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Double>, PrimitiveConverter<Double>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class DoubleAttributeConverter
extends Object
implements AttributeConverter<Double>, PrimitiveConverter<Double>

A converter between Double 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. For less precision or smaller values, consider using FloatAttributeConverter. For greater precision or larger values, consider using BigDecimalAttributeConverter.

If values are known to be whole numbers, it is recommended to use a perfect-precision whole number representation like those provided by ShortAttributeConverter, IntegerAttributeConverter or BigIntegerAttributeConverter.

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 DoubleAttributeConverter	create()
EnhancedType<Double>	primitiveType()	The type supported by this converter.
AttributeValue	transformFrom(Double input)	Convert the provided Java object into an AttributeValue.
Double	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<Double>	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 DoubleAttributeConverter create()

type

public EnhancedType<Double> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Double>

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

transformFrom

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

transformTo

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

primitiveType

public EnhancedType<Double> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Double>