commonMain.aws.sdk.kotlin.hll.dynamodbmapper.values.scalars.EnumConverter.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dynamodb-mapper-jvm Show documentation

High level DynamoDbMapper client

There is a newer version: 1.3.99-beta

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.sdk.kotlin.hll.dynamodbmapper.values.scalars

import aws.sdk.kotlin.hll.dynamodbmapper.values.ValueConverter
import aws.sdk.kotlin.hll.mapping.core.converters.Converter
import aws.sdk.kotlin.hll.mapping.core.converters.andThenFrom
import aws.smithy.kotlin.runtime.ExperimentalApi

/**
 * Converts between [Enum] and
 * [DynamoDB `S` values](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.NamingRulesDataTypes.html#HowItWorks.DataTypes.String)
 * @param E The [Enum] type to convert
 */
@ExperimentalApi
public class EnumConverter>(
    private val enumToStringConverter: Converter,
) : ValueConverter by StringConverter.andThenFrom(enumToStringConverter)

/**
 * Instantiates a new [ValueConverter] for enums of type [E]
 * @param E The [Enum] type for which to create a [ValueConverter]
 */
@ExperimentalApi
public inline fun > EnumConverter(): EnumConverter =
    EnumConverter(
        enumToStringConverter = Converter(
            convertTo = { from: E -> from.name },
            convertFrom = { to: String -> enumValueOf(to) },
        ),
    )