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

/**
 * Represents a `NOT` 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` (i.e., `operand` evaluates to `false`).
 */
@ExperimentalApi
public interface NotExpr : BooleanExpr {
    /**
     * The condition to negate
     */
    public val operand: BooleanExpr

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

/**
 * Creates a new `NOT` expression
 * @param operand The condition to negate
 */
@ExperimentalApi
public fun NotExpr(operand: BooleanExpr): NotExpr = NotExprImpl(operand)