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

Class ShortAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Short>, PrimitiveConverter<Short>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class ShortAttributeConverter
extends Object
implements AttributeConverter<Short>, PrimitiveConverter<Short>

A converter between Short and AttributeValue.

This stores values in DynamoDB as a number.

This supports reading numbers between Short.MIN_VALUE and Short.MAX_VALUE from DynamoDB. For larger numbers, consider using IntegerAttributeConverter, 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 ShortStringConverter	STRING_CONVERTER

Constructor Summary

Constructors

Constructor	Description
ShortAttributeConverter()

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

Field Detail

STRING_CONVERTER

public static final ShortStringConverter STRING_CONVERTER

Constructor Detail

ShortAttributeConverter

public ShortAttributeConverter()

Method Detail

create

public static ShortAttributeConverter create()

type

public EnhancedType<Short> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Short>

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

transformFrom

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

transformTo

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

primitiveType

public EnhancedType<Short> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Short>