Class ByteArrayAttributeConverter

java.lang.Object

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

All Implemented Interfaces:

AttributeConverter<byte[]>

@SdkInternalApi
@ThreadSafe
@Immutable
public final class ByteArrayAttributeConverter
extends Object
implements AttributeConverter<byte[]>

A converter between byte[] and AttributeValue.

This stores values in DynamoDB as a binary blob.

This supports reading every byte value supported by DynamoDB, making it fully compatible with custom converters as well as internal converters (e.g. SdkBytesAttributeConverter).

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 ByteArrayAttributeConverter	create()
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 ByteArrayAttributeConverter create()

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[]>

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[]>