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

Class OptionalIntAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<OptionalInt>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class OptionalIntAttributeConverter
extends Object
implements AttributeConverter<OptionalInt>

A converter between OptionalInt and AttributeValue.

This stores values in DynamoDB as a number.

This supports reading numbers between Integer.MIN_VALUE and Integer.MAX_VALUE from DynamoDB. Null values are converted to OptionalInt.empty(). For larger numbers, consider using the OptionalLongAttributeConverter or the OptionalAttributeConverter along with a BigInteger. For shorter numbers, consider using the OptionalAttributeConverter along with a Short type.

This does not support reading decimal numbers. For decimal numbers, consider using OptionalDoubleAttributeConverter, or the OptionalAttributeConverter with a Float or BigDecimal. Decimal numbers will cause a NumberFormatException on conversion.

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

type

public EnhancedType<OptionalInt> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<OptionalInt>

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

create

public static OptionalIntAttributeConverter create()

transformFrom

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

transformTo

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