divkit.dsl.ArrayVariable.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kotlin-json-builder Show documentation

DivKit is an open source Server-Driven UI (SDUI) framework. SDUI is a an emerging technique that leverage the server to build the user interfaces of their mobile app.

There is a newer version: 30.19.0

Show newest version

@file:Suppress(
    "unused",
    "UNUSED_PARAMETER",
)

package divkit.dsl

import com.fasterxml.jackson.annotation.JsonAnyGetter
import com.fasterxml.jackson.annotation.JsonIgnore
import com.fasterxml.jackson.annotation.JsonValue
import divkit.dsl.annotation.*
import divkit.dsl.core.*
import divkit.dsl.scope.*
import kotlin.Any
import kotlin.String
import kotlin.Suppress
import kotlin.collections.List
import kotlin.collections.Map

/**
 * An arbitrary array in JSON format.
 * 
 * Can be created using the method [arrayVariable].
 * 
 * Required parameters: `value, type, name`.
 */
@Generated
class ArrayVariable internal constructor(
    @JsonIgnore
    val properties: Properties,
) : Variable {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(
        mapOf("type" to "array")
    )

    operator fun plus(additive: Properties): ArrayVariable = ArrayVariable(
        Properties(
            name = additive.name ?: properties.name,
            value = additive.value ?: properties.value,
        )
    )

    class Properties internal constructor(
        /**
         * Variable name.
         */
        val name: Property?,
        /**
         * Value.
         */
        val value: Property>?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("name", name)
            result.tryPutProperty("value", value)
            return result
        }
    }
}

/**
 * @param name Variable name.
 * @param value Value.
 */
@Generated
fun DivScope.arrayVariable(
    `use named arguments`: Guard = Guard.instance,
    name: String? = null,
    value: List? = null,
): ArrayVariable = ArrayVariable(
    ArrayVariable.Properties(
        name = valueOrNull(name),
        value = valueOrNull(value),
    )
)

/**
 * @param name Variable name.
 * @param value Value.
 */
@Generated
fun DivScope.arrayVariableProps(
    `use named arguments`: Guard = Guard.instance,
    name: String? = null,
    value: List? = null,
) = ArrayVariable.Properties(
    name = valueOrNull(name),
    value = valueOrNull(value),
)

/**
 * @param name Variable name.
 * @param value Value.
 */
@Generated
fun TemplateScope.arrayVariableRefs(
    `use named arguments`: Guard = Guard.instance,
    name: ReferenceProperty? = null,
    value: ReferenceProperty>? = null,
) = ArrayVariable.Properties(
    name = name,
    value = value,
)

/**
 * @param name Variable name.
 * @param value Value.
 */
@Generated
fun ArrayVariable.override(
    `use named arguments`: Guard = Guard.instance,
    name: String? = null,
    value: List? = null,
): ArrayVariable = ArrayVariable(
    ArrayVariable.Properties(
        name = valueOrNull(name) ?: properties.name,
        value = valueOrNull(value) ?: properties.value,
    )
)

/**
 * @param name Variable name.
 * @param value Value.
 */
@Generated
fun ArrayVariable.defer(
    `use named arguments`: Guard = Guard.instance,
    name: ReferenceProperty? = null,
    value: ReferenceProperty>? = null,
): ArrayVariable = ArrayVariable(
    ArrayVariable.Properties(
        name = name ?: properties.name,
        value = value ?: properties.value,
    )
)

@Generated
fun ArrayVariable.asList() = listOf(this)