Class ByteAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<Byte>, PrimitiveConverter<Byte>

@ThreadSafe
@Immutable
public final class ByteAttributeConverter
extends Object
implements AttributeConverter<Byte>, PrimitiveConverter<Byte>

A converter between Byte and AttributeValue.

This stores values in DynamoDB as a single byte.

This only supports reading a single byte from DynamoDB. Any binary data greater than 1 byte will cause a RuntimeException during 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 ByteAttributeConverter	create()
EnhancedType<Byte>	primitiveType()	The type supported by this converter.
AttributeValue	transformFrom(Byte input)	Convert the provided Java object into an AttributeValue.
Byte	transformTo(AttributeValue input)	Convert the provided AttributeValue into a Java object.
EnhancedType<Byte>	type()	The type supported by this converter.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ByteAttributeConverter create()

transformFrom

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

transformTo

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

type

public EnhancedType<Byte> type()

Description copied from interface: AttributeConverter

The type supported by this converter.

Specified by:

type in interface AttributeConverter<Byte>

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

primitiveType

public EnhancedType<Byte> primitiveType()

Description copied from interface: PrimitiveConverter

The type supported by this converter.

Specified by:

primitiveType in interface PrimitiveConverter<Byte>