Class IntegerAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Integer>, PrimitiveConverter<Integer>

@ThreadSafe
@Immutable
public final class IntegerAttributeConverter
extends Object
implements AttributeConverter<Integer>, PrimitiveConverter<Integer>

A converter between Integer and AttributeValue.

This stores values in DynamoDB as a number.

This supports reading numbers between Integer.MIN_VALUE and Integer.MAX_VALUE from DynamoDB. For smaller numbers, consider using ShortAttributeConverter. For larger numbers, consider using LongAttributeConverter or BigIntegerAttributeConverter. Numbers outside of the supported range will cause a NumberFormatException on conversion.

This does not support reading decimal numbers. For decimal numbers, consider using FloatAttributeConverter, DoubleAttributeConverter or BigDecimalAttributeConverter. Decimal numbers will cause a NumberFormatException on conversion.

Field Summary

Fields

Modifier and Type	Field	Description
static final IntegerStringConverter	INTEGER_STRING_CONVERTER

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

INTEGER_STRING_CONVERTER

public static final IntegerStringConverter INTEGER_STRING_CONVERTER

Method Details

create

public static IntegerAttributeConverter create()

type

public EnhancedType<Integer> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Integer>

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

transformFrom

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

transformTo

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

primitiveType

public EnhancedType<Integer> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Integer>