com.mongodb.kotlin.client.property.KPropertyPath.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mongodb-driver-kotlin-extensions Show documentation
The MongoDB Kotlin Driver Extensions
There is a newer version: 5.3.0
Show newest version
/*
 * Copyright 2008-present MongoDB, Inc.
 * Copyright (C) 2016/2022 Litote
 *
 * 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
 *
 *   http://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.
 *
 * @custom-license-header
 */
package com.mongodb.kotlin.client.property

import com.mongodb.annotations.Sealed
import com.mongodb.kotlin.client.model.path
import kotlin.reflect.KParameter
import kotlin.reflect.KProperty1
import kotlin.reflect.KType
import kotlin.reflect.KTypeParameter
import kotlin.reflect.KVisibility

/**
 * A property path, operations on which take one receiver as a parameter.
 *
 * @param T the type of the receiver which should be used to obtain the value of the property.
 * @param R the type of the property.
 */
@Sealed
public open class KPropertyPath(
    private val previous: KPropertyPath?,
    internal val property: KProperty1<*, R?>
) : KProperty1 {

    @Suppress("UNCHECKED_CAST")
    internal constructor(
        previous: KProperty1<*, Any?>,
        property: KProperty1<*, R?>
    ) : this(
        if (previous is KPropertyPath<*, *>) {
            previous as KPropertyPath?
        } else {
            KPropertyPath(null as (KPropertyPath?), previous)
        },
        property)

    private val path: String by lazy { "${previous?.path?.let { "$it." } ?: ""}${property.path()}" }

    override val name: String
        get() = path

    override val annotations: List
        get() = unSupportedOperation()
    override val getter: KProperty1.Getter
        get() = unSupportedOperation()
    override val isAbstract: Boolean
        get() = unSupportedOperation()
    override val isConst: Boolean
        get() = unSupportedOperation()
    override val isFinal: Boolean
        get() = unSupportedOperation()
    override val isLateinit: Boolean
        get() = unSupportedOperation()
    override val isOpen: Boolean
        get() = unSupportedOperation()
    override val isSuspend: Boolean
        get() = unSupportedOperation()
    override val parameters: List
        get() = unSupportedOperation()
    override val returnType: KType
        get() = unSupportedOperation()
    override val typeParameters: List
        get() = unSupportedOperation()
    override val visibility: KVisibility?
        get() = unSupportedOperation()
    override fun invoke(p1: T): R = unSupportedOperation()
    override fun call(vararg args: Any?): R = unSupportedOperation()
    override fun callBy(args: Map): R = unSupportedOperation()
    override fun get(receiver: T): R = unSupportedOperation()
    override fun getDelegate(receiver: T): Any? = unSupportedOperation()

    public companion object {

        private fun unSupportedOperation(): Nothing = throw UnsupportedOperationException()

        internal class CustomProperty(val previous: KPropertyPath<*, T>, path: String) : KProperty1 {
            override val annotations: List
                get() = emptyList()

            override val getter: KProperty1.Getter
                get() = unSupportedOperation()
            override val isAbstract: Boolean
                get() = previous.isAbstract
            override val isConst: Boolean
                get() = previous.isConst
            override val isFinal: Boolean
                get() = previous.isFinal
            override val isLateinit: Boolean
                get() = previous.isLateinit
            override val isOpen: Boolean
                get() = previous.isOpen
            override val isSuspend: Boolean
                get() = previous.isSuspend
            override val name: String = path
            override val parameters: List
                get() = previous.parameters
            override val returnType: KType
                get() = unSupportedOperation()
            override val typeParameters: List
                get() = previous.typeParameters
            override val visibility: KVisibility?
                get() = previous.visibility
            override fun call(vararg args: Any?): R = unSupportedOperation()
            override fun callBy(args: Map): R = unSupportedOperation()
            override fun get(receiver: T): R = unSupportedOperation()
            override fun getDelegate(receiver: T): Any? = unSupportedOperation()
            override fun invoke(p1: T): R = unSupportedOperation()
        }

        /** Provides "fake" property with custom name. */
        public fun  customProperty(previous: KPropertyPath<*, T>, path: String): KProperty1 =
            CustomProperty(previous, path)
    }
}

/** Base class for collection property path. */
public open class KCollectionPropertyPath>(
    previous: KPropertyPath?,
    property: KProperty1<*, Iterable?>
) : KPropertyPath?>(previous, property) {

    /** To be overridden to return the right type. */
    @Suppress("UNCHECKED_CAST")
    public open fun memberWithAdditionalPath(additionalPath: String): MEMBER =
        KPropertyPath(
            this as KProperty1?>, customProperty(this as KPropertyPath<*, T>, additionalPath))
            as MEMBER

    /** [The positional array operator $](https://docs.mongodb.com/manual/reference/operator/update/positional/) */
    public val posOp: MEMBER
        get() = memberWithAdditionalPath("\$")

    /** [The all positional operator $[]](https://docs.mongodb.com/manual/reference/operator/update/positional-all/) */
    public val allPosOp: MEMBER
        get() = memberWithAdditionalPath("\$[]")

    /**
     * [The filtered positional operator $[\]]
     * (https://docs.mongodb.com/manual/reference/operator/update/positional-filtered/)
     */
    public fun filteredPosOp(identifier: String): MEMBER = memberWithAdditionalPath("\$[$identifier]")

    /** In order to write array indexed expressions (like `accesses.0.timestamp`) */
    public fun pos(position: Int): MEMBER = memberWithAdditionalPath(position.toString())
}

/** A property path for a collection property. */
public class KCollectionSimplePropertyPath(
    previous: KPropertyPath?,
    property: KProperty1<*, Iterable?>
) : KCollectionPropertyPath>(previous, property)

/** Base class for map property path. */
public open class KMapPropertyPath>(
    previous: KPropertyPath?,
    property: KProperty1<*, Map?>
) : KPropertyPath?>(previous, property) {

    /** To be overridden to returns the right type. */
    @Suppress("UNCHECKED_CAST")
    public open fun memberWithAdditionalPath(additionalPath: String): MEMBER =
        KPropertyPath(
            this as KProperty1?>, customProperty(this as KPropertyPath<*, T>, additionalPath))
            as MEMBER

    /** Key projection of map. Sample: `Restaurant::localeMap.keyProjection(Locale.ENGLISH).path()` */
    public fun keyProjection(key: K): MEMBER = memberWithAdditionalPath(key.toString())
}

/** A property path for a map property. */
public class KMapSimplePropertyPath(previous: KPropertyPath?, property: KProperty1<*, Map?>) :
    KMapPropertyPath>(previous, property)