divkit.dsl.InputValidatorExpression.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

/**
 * [Calculated expression](../../expressions) validator.
 * 
 * Can be created using the method [inputValidatorExpression].
 * 
 * Required parameters: `variable, type, label_id, condition`.
 */
@Generated
class InputValidatorExpression internal constructor(
    @JsonIgnore
    val properties: Properties,
) : InputValidator {
    @JsonAnyGetter
    internal fun getJsonProperties(): Map = properties.mergeWith(
        mapOf("type" to "expression")
    )

    operator fun plus(additive: Properties): InputValidatorExpression = InputValidatorExpression(
        Properties(
            allowEmpty = additive.allowEmpty ?: properties.allowEmpty,
            condition = additive.condition ?: properties.condition,
            labelId = additive.labelId ?: properties.labelId,
            variable = additive.variable ?: properties.variable,
        )
    )

    class Properties internal constructor(
        /**
         * Determines whether the empty field value is valid.
         * Default value: `false`.
         */
        val allowEmpty: Property?,
        /**
         * [Calculated expression](../../expressions) used as a value validity condition.
         */
        val condition: Property?,
        /**
         * ID of the text element containing the error message. The message will also be used for providing access.
         */
        val labelId: Property?,
        /**
         * The name of the variable that stores the calculation results.
         */
        val variable: Property?,
    ) {
        internal fun mergeWith(properties: Map): Map {
            val result = mutableMapOf()
            result.putAll(properties)
            result.tryPutProperty("allow_empty", allowEmpty)
            result.tryPutProperty("condition", condition)
            result.tryPutProperty("label_id", labelId)
            result.tryPutProperty("variable", variable)
            return result
        }
    }
}

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 * @param variable The name of the variable that stores the calculation results.
 */
@Generated
fun DivScope.inputValidatorExpression(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: Boolean? = null,
    condition: Boolean? = null,
    labelId: String? = null,
    variable: String? = null,
): InputValidatorExpression = InputValidatorExpression(
    InputValidatorExpression.Properties(
        allowEmpty = valueOrNull(allowEmpty),
        condition = valueOrNull(condition),
        labelId = valueOrNull(labelId),
        variable = valueOrNull(variable),
    )
)

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 * @param variable The name of the variable that stores the calculation results.
 */
@Generated
fun DivScope.inputValidatorExpressionProps(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: Boolean? = null,
    condition: Boolean? = null,
    labelId: String? = null,
    variable: String? = null,
) = InputValidatorExpression.Properties(
    allowEmpty = valueOrNull(allowEmpty),
    condition = valueOrNull(condition),
    labelId = valueOrNull(labelId),
    variable = valueOrNull(variable),
)

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 * @param variable The name of the variable that stores the calculation results.
 */
@Generated
fun TemplateScope.inputValidatorExpressionRefs(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: ReferenceProperty? = null,
    condition: ReferenceProperty? = null,
    labelId: ReferenceProperty? = null,
    variable: ReferenceProperty? = null,
) = InputValidatorExpression.Properties(
    allowEmpty = allowEmpty,
    condition = condition,
    labelId = labelId,
    variable = variable,
)

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 * @param variable The name of the variable that stores the calculation results.
 */
@Generated
fun InputValidatorExpression.override(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: Boolean? = null,
    condition: Boolean? = null,
    labelId: String? = null,
    variable: String? = null,
): InputValidatorExpression = InputValidatorExpression(
    InputValidatorExpression.Properties(
        allowEmpty = valueOrNull(allowEmpty) ?: properties.allowEmpty,
        condition = valueOrNull(condition) ?: properties.condition,
        labelId = valueOrNull(labelId) ?: properties.labelId,
        variable = valueOrNull(variable) ?: properties.variable,
    )
)

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 * @param variable The name of the variable that stores the calculation results.
 */
@Generated
fun InputValidatorExpression.defer(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: ReferenceProperty? = null,
    condition: ReferenceProperty? = null,
    labelId: ReferenceProperty? = null,
    variable: ReferenceProperty? = null,
): InputValidatorExpression = InputValidatorExpression(
    InputValidatorExpression.Properties(
        allowEmpty = allowEmpty ?: properties.allowEmpty,
        condition = condition ?: properties.condition,
        labelId = labelId ?: properties.labelId,
        variable = variable ?: properties.variable,
    )
)

/**
 * @param allowEmpty Determines whether the empty field value is valid.
 * @param condition [Calculated expression](../../expressions) used as a value validity condition.
 * @param labelId ID of the text element containing the error message. The message will also be used for providing access.
 */
@Generated
fun InputValidatorExpression.evaluate(
    `use named arguments`: Guard = Guard.instance,
    allowEmpty: ExpressionProperty? = null,
    condition: ExpressionProperty? = null,
    labelId: ExpressionProperty? = null,
): InputValidatorExpression = InputValidatorExpression(
    InputValidatorExpression.Properties(
        allowEmpty = allowEmpty ?: properties.allowEmpty,
        condition = condition ?: properties.condition,
        labelId = labelId ?: properties.labelId,
        variable = properties.variable,
    )
)

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