divkit.dsl.StringVariable.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
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.
@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
/**
* A string variable.
*
* Can be created using the method [stringVariable].
*
* Required parameters: `value, type, name`.
*/
@Generated
class StringVariable internal constructor(
@JsonIgnore
val properties: Properties,
) : Variable {
@JsonAnyGetter
internal fun getJsonProperties(): Map = properties.mergeWith(
mapOf("type" to "string")
)
operator fun plus(additive: Properties): StringVariable = StringVariable(
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.stringVariable(
`use named arguments`: Guard = Guard.instance,
name: String? = null,
value: String? = null,
): StringVariable = StringVariable(
StringVariable.Properties(
name = valueOrNull(name),
value = valueOrNull(value),
)
)
/**
* @param name Variable name.
* @param value Value.
*/
@Generated
fun DivScope.stringVariableProps(
`use named arguments`: Guard = Guard.instance,
name: String? = null,
value: String? = null,
) = StringVariable.Properties(
name = valueOrNull(name),
value = valueOrNull(value),
)
/**
* @param name Variable name.
* @param value Value.
*/
@Generated
fun TemplateScope.stringVariableRefs(
`use named arguments`: Guard = Guard.instance,
name: ReferenceProperty? = null,
value: ReferenceProperty? = null,
) = StringVariable.Properties(
name = name,
value = value,
)
/**
* @param name Variable name.
* @param value Value.
*/
@Generated
fun StringVariable.override(
`use named arguments`: Guard = Guard.instance,
name: String? = null,
value: String? = null,
): StringVariable = StringVariable(
StringVariable.Properties(
name = valueOrNull(name) ?: properties.name,
value = valueOrNull(value) ?: properties.value,
)
)
/**
* @param name Variable name.
* @param value Value.
*/
@Generated
fun StringVariable.defer(
`use named arguments`: Guard = Guard.instance,
name: ReferenceProperty? = null,
value: ReferenceProperty? = null,
): StringVariable = StringVariable(
StringVariable.Properties(
name = name ?: properties.name,
value = value ?: properties.value,
)
)
@Generated
fun StringVariable.asList() = listOf(this)