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

Class OptionalLongAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<OptionalLong>

@ThreadSafe
@Immutable
public final class OptionalLongAttributeConverter
extends Object
implements AttributeConverter<OptionalLong>

A converter between OptionalLong and AttributeValue.

This stores values in DynamoDB as a number.

This supports reading numbers between Long.MIN_VALUE and Long.MAX_VALUE from DynamoDB. Null values are converted to OptionalLong.empty(). For larger numbers, consider using the OptionalAttributeConverter along with a BigInteger. For shorter numbers, consider using the OptionalIntAttributeConverter or 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 OptionalLongAttributeConverter	create()
AttributeValue	transformFrom(OptionalLong input)	Convert the provided Java object into an AttributeValue.
OptionalLong	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<OptionalLong>	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<OptionalLong> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<OptionalLong>

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

create

public static OptionalLongAttributeConverter create()

transformFrom

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

transformTo

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