software.amazon.awssdk.enhanced.dynamodb

Class EnumAttributeConverter<T extends Enum<T>>

java.lang.Object

software.amazon.awssdk.enhanced.dynamodb.EnumAttributeConverter<T>

All Implemented Interfaces:

AttributeConverter<T>

public final class EnumAttributeConverter<T extends Enum<T>>
extends Object
implements AttributeConverter<T>

A converter between an Enum and AttributeValue.

This stores values in DynamoDB as a string.

Use EnumAttributeConverter::create in order to use Enum::toString as the enum identifier

Use EnumAttributeConverter::createWithNameAsKeys in order to use Enum::name as the enum identifier

This can be created via create(Class).

Method Summary

Modifier and Type	Method and Description
AttributeValueType	attributeValueType() Returns the AttributeValueType of the converter.
static <T extends Enum<T>> EnumAttributeConverter<T>	create(Class<T> enumClass) Creates an EnumAttributeConverter for an Enum.
static <T extends Enum<T>> EnumAttributeConverter<T>	createWithNameAsKeys(Class<T> enumClass) Creates an EnumAttributeConverter for an Enum.
AttributeValue	transformFrom(T input) Returns the proper AttributeValue for the given enum type.
T	transformTo(AttributeValue input) Returns the proper enum type for the given AttributeValue input.
EnhancedType<T>	type() Returns the EnhancedType of the converter.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static <T extends Enum<T>> EnumAttributeConverter<T> create(Class<T> enumClass)

Creates an EnumAttributeConverter for an Enum.

Uses Enum::toString as the enum identifier.

Type Parameters:

T - the enum subclass

Parameters:

enumClass - The enum class to be used

Returns:

an EnumAttributeConverter

createWithNameAsKeys

public static <T extends Enum<T>> EnumAttributeConverter<T> createWithNameAsKeys(Class<T> enumClass)

Creates an EnumAttributeConverter for an Enum.

Uses Enum::name as the enum identifier.

Type Parameters:

T - the enum subclass

Parameters:

enumClass - The enum class to be used

Returns:

an EnumAttributeConverter

transformFrom

public AttributeValue transformFrom(T input)

Returns the proper AttributeValue for the given enum type.

Specified by:

transformFrom in interface AttributeConverter<T extends Enum<T>>

Parameters:

input - the enum type to be converted

Returns:

AttributeValue

transformTo

public T transformTo(AttributeValue input)

Returns the proper enum type for the given AttributeValue input.

Specified by:

transformTo in interface AttributeConverter<T extends Enum<T>>

Parameters:

input - the AttributeValue to be converted

Returns:

an enum type

type

public EnhancedType<T> type()

Returns the EnhancedType of the converter.

Specified by:

type in interface AttributeConverter<T extends Enum<T>>

Returns:

EnhancedType

attributeValueType

public AttributeValueType attributeValueType()

Returns the AttributeValueType of the converter.

Specified by:

attributeValueType in interface AttributeConverter<T extends Enum<T>>

Returns:

AttributeValueType