commonMain.aws.sdk.kotlin.hll.dynamodbmapper.expressions.OrExpr.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.OrExprImpl
import aws.smithy.kotlin.runtime.ExperimentalApi

/**
 * Represents an `OR` expression as described in
 * [DynamoDB's **logical evaluations** documentation](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/Expressions.OperatorsAndFunctions.html#Expressions.OperatorsAndFunctions.LogicalEvaluations).
 * This expression will be true if `(operand[0] || operand[1] || ... || operand[n - 1])`.
 */
@ExperimentalApi
public interface OrExpr : BooleanExpr {
    /**
     * A list of 2 or more [BooleanExpr] conditions which are ANDed together
     */
    public val operands: List

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

/**
 * Creates a new [OrExpr] with the given [operands]
 * @param operands A list of 2 or more [BooleanExpr] conditions which are ORed together
 */
@ExperimentalApi
public fun OrExpr(operands: List): OrExpr = OrExprImpl(operands)