commonMain.aws.sdk.kotlin.hll.dynamodbmapper.model.Item.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.model

import aws.sdk.kotlin.hll.dynamodbmapper.model.internal.ItemImpl
import aws.sdk.kotlin.hll.dynamodbmapper.util.dynamicAttr
import aws.sdk.kotlin.services.dynamodb.model.AttributeValue
import aws.smithy.kotlin.runtime.ExperimentalApi
import kotlin.jvm.JvmName

/**
 * An immutable representation of a low-level item in a DynamoDB table. Items consist of attributes, each of which have
 * a string name and a value.
 */
@ExperimentalApi
public interface Item : Map

/**
 * Builds a new immutable [Item] by populating a [MutableItem] using the provided [block] and returning a read-only copy
 * of it.
 * @param block The block to apply to the [MutableItem] builder
 */
@ExperimentalApi
public inline fun buildItem(block: MutableItem.() -> Unit): Item =
    mutableMapOf().toMutableItem().apply(block).toItem()

/**
 * Convert this [Item] into a [MutableItem]. Changes to the returned instance do not affect this instance.
 */
@ExperimentalApi
public fun Item.toMutableItem(): MutableItem = toMutableMap().toMutableItem()

/**
 * Converts this map to an immutable [Item]
 */
@ExperimentalApi
public fun Map.toItem(): Item = ItemImpl(this)

/**
 * Dynamically converts this map to an immutable [Item]
 */
@JvmName("mapStringAnyToItem")
internal fun Map.toItem() = mapValues { (_, v) -> dynamicAttr(v) }.toItem()

/**
 * Returns a new immutable [Item] with the specified attributes, given as name-value pairs
 * @param pairs A collection of [Pair]<[String], [AttributeValue]> where the first value is the attribute name and the
 * second is the attribute value.
 */
@ExperimentalApi
public fun itemOf(vararg pairs: Pair): Item = mapOf(*pairs).toItem()

/**
 * Returns a new immutable [Item] with the specified attributes, given as name-value pairs
 * @param pairs A collection of [Pair]<[String], [Any]`?`> where the first value is the attribute name and the
 * second is the attribute value.
 */
@JvmName("itemOfPairStringAny")
internal fun itemOf(vararg pairs: Pair): Item = mapOf(*pairs).toItem()