commonMain.aws.sdk.kotlin.hll.dynamodbmapper.expressions.InExpr.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.expressions

import aws.sdk.kotlin.hll.dynamodbmapper.expressions.internal.InExprImpl
import aws.smithy.kotlin.runtime.ExperimentalApi

/**
 * Represents an `IN` expression as described in
 * [DynamoDB's **making comparisons** documentation](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.Comparators).
 * This expression will be true if `value in set` (or, equivalently, if `set.contains(value)`).
 */
@ExperimentalApi
public interface InExpr : BooleanExpr {
    /**
     * The value to check for in [set]
     */
    public val value: Expression

    /**
     * The set of values to compare against [value]
     */
    public val set: Collection

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

/**
 * Creates a new `IN` expression
 * @param value The value to check for in [set]
 * @param set The set of values to compare against [value]
 */
@ExperimentalApi
public fun InExpr(value: Expression, set: Collection): InExpr = InExprImpl(value, set)