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

Class LongAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Long>, PrimitiveConverter<Long>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class LongAttributeConverter
extends Object
implements AttributeConverter<Long>, PrimitiveConverter<Long>

A converter between Long and AttributeValue.

This stores values in DynamoDB as a number.

This supports reading numbers between Long.MIN_VALUE and Long.MAX_VALUE from DynamoDB. For smaller numbers, consider using ShortAttributeConverter or IntegerAttributeConverter. For larger numbers, consider using 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.

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

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Long>

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

create

public static LongAttributeConverter create()

transformFrom

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

transformTo

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

primitiveType

public EnhancedType<Long> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Long>