org.springframework.data.cassandra.core.ReactiveSelectOperationExtensions.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spring-data-cassandra Show documentation
Cassandra support for Spring Data
There is a newer version: 4.2.5
Show newest version
/*
 * Copyright 2018-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.cassandra.core

import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.reactive.asFlow
import kotlinx.coroutines.reactive.awaitFirstOrNull
import kotlinx.coroutines.reactive.awaitSingle
import kotlin.reflect.KClass

/**
 * Extensions for [ReactiveSelectOperation].
 *
 * @author Mark Paluch
 * @since 2.1
 */

/**
 * Extension for [ReactiveSelectOperation.query] providing a [KClass] based variant.
 */
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("query()"))
fun  ReactiveSelectOperation.query(entityClass: KClass): ReactiveSelectOperation.ReactiveSelect =
		query(entityClass.java)

/**
 * Extension for [ReactiveSelectOperation.query] leveraging reified type parameters.
 */
inline fun  ReactiveSelectOperation.query(): ReactiveSelectOperation.ReactiveSelect =
		query(T::class.java)

/**
 * Extension for [ReactiveSelectOperation.SelectWithProjection. as] providing a [KClass] based variant.
 */
@Deprecated("Since 2.2, use the reified variant", replaceWith = ReplaceWith("asType()"))
fun  ReactiveSelectOperation.SelectWithProjection<*>.asType(resultType: KClass): ReactiveSelectOperation.SelectWithQuery =
		`as`(resultType.java)

/**
 * Extension for [ReactiveSelectOperation.FindWithProjection. as] leveraging reified type parameters.
 */
inline fun  ReactiveSelectOperation.SelectWithProjection<*>.asType(): ReactiveSelectOperation.SelectWithQuery =
		`as`(T::class.java)

/**
 * Non-nullable Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.one].
 *
 * @author Sebastien Deleuze
 * @since 2.2
 */
suspend inline fun  ReactiveSelectOperation.TerminatingSelect.awaitOne(): T =
		one().awaitSingle()

/**
 * Nullable Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.one].
 *
 * @author Mark Paluch
 * @author Sebastien Deleuze
 * @since 2.2
 */
suspend inline fun  ReactiveSelectOperation.TerminatingSelect.awaitOneOrNull(): T? =
		one().awaitFirstOrNull()

/**
 * Non-nullable Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.first].
 *
 * @author Sebastien Deleuze
 * @since 2.2
 */
suspend inline fun  ReactiveSelectOperation.TerminatingSelect.awaitFirst(): T =
		first().awaitSingle()

/**
 * Nullable Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.first].
 *
 * @author Mark Paluch
 * @author Sebastien Deleuze
 * @since 2.2
 */
suspend inline fun  ReactiveSelectOperation.TerminatingSelect.awaitFirstOrNull(): T? =
		first().awaitFirstOrNull()

/**
 * Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.count].
 *
 * @author Mark Paluch
 * @since 2.2
 */
suspend fun  ReactiveSelectOperation.TerminatingSelect.awaitCount(): Long =
		count().awaitSingle()

/**
 * Coroutines variant of [ReactiveSelectOperation.TerminatingSelect.exists].
 *
 * @author Mark Paluch
 * @since 2.2
 */
suspend fun  ReactiveSelectOperation.TerminatingSelect.awaitExists(): Boolean =
		exists().awaitSingle()

/**
 * Coroutines [Flow] variant of [ReactiveSelectOperation.TerminatingSelect.all].
 *
 * @author Sebastien Deleuze
 * @since 2.2
 */
fun  ReactiveSelectOperation.TerminatingSelect.flow(): Flow =
		all().asFlow()