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

Class BigDecimalAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<BigDecimal>

@ThreadSafe
 @Immutable
public final class BigDecimalAttributeConverter
extends Object
implements AttributeConverter<BigDecimal>

A converter between BigDecimal and AttributeValue.

This stores values in DynamoDB as a number.

This supports perfect precision with the full range of numbers that can be stored in DynamoDB. For less precision or smaller values, consider using FloatAttributeConverter or DoubleAttributeConverter.

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 and Description
AttributeValueType	attributeValueType() The AttributeValueType that a converter stores and reads values from DynamoDB via the AttributeValue class.
static BigDecimalAttributeConverter	create()
AttributeValue	transformFrom(BigDecimal input) Convert the provided Java object into an AttributeValue.
BigDecimal	transformTo(AttributeValue input) Convert the provided AttributeValue into a Java object.
EnhancedType<BigDecimal>	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 BigDecimalAttributeConverter create()

type

public EnhancedType<BigDecimal> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<BigDecimal>

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

transformFrom

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

transformTo

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