commonMain.aws.sdk.kotlin.hll.dynamodbmapper.expressions.LiteralExpr.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.73-beta
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */
package aws.sdk.kotlin.hll.dynamodbmapper.expressions

import aws.sdk.kotlin.hll.dynamodbmapper.expressions.internal.LiteralExprImpl
import aws.sdk.kotlin.hll.dynamodbmapper.util.attr
import aws.sdk.kotlin.services.dynamodb.model.AttributeValue
import aws.smithy.kotlin.runtime.ExperimentalApi
import kotlin.jvm.JvmName

/**
 * Represents an expression that consists of a single literal value
 */
@ExperimentalApi
public interface LiteralExpr : Expression {
    /**
     * The low-level DynamoDB representation of the literal value
     */
    public val value: AttributeValue

    override fun  accept(visitor: ExpressionVisitor): T = visitor.visit(this)
}

/**
 * Creates a new literal expression
 * @param value The low-level DynamoDB representation of the literal value
 */
@ExperimentalApi
public fun LiteralExpr(value: AttributeValue): LiteralExpr = LiteralExprImpl(value)

private val NULL_LITERAL = LiteralExpr(attr(null))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: Boolean?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: ByteArray?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: List?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: Map?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@Suppress("UNUSED_PARAMETER")
public fun LiteralExpr(value: Nothing?): LiteralExpr = NULL_LITERAL

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: Number?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetByteArray")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetNumber")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetString")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetUByte")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetUInt")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetULong")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
@JvmName("LiteralExprSetUShort")
public fun LiteralExpr(value: Set?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: String?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: UByte?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: UInt?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: ULong?): LiteralExpr = LiteralExpr(attr(value))

/**
 * Creates a new literal expression
 * @param value The literal value which will be converted to an [AttributeValue]
 */
@ExperimentalApi
public fun LiteralExpr(value: UShort?): LiteralExpr = LiteralExpr(attr(value))