kform/tech.ostack.kform/Validation

Validation

abstract class Validation<in T> : Computation(source)

Validation for values of type T.

Validations may depend on other values. These dependencies may be defined via the dependency function, by providing the path of the dependency relative to the value being validated.

Example validation that emits an error when the integer being validated is odd if the value of a dependency allowOdd is false:

object DisallowOdd : Validation<Int>() {
    private val ValidationContext.allowOdd: Boolean by dependency("../allowOdd")

    ValidationContext.validate() = flow {
        if (!allowOdd && value % 2 != 0) {
            emit(ValidationError("oddNotAllowed"))
        }
    }
}

Inheritors

Constructors

Validation

constructor()

Properties

dependencies

open override val dependencies: Map<String, DependencyInfo>

Dependencies of the validation. Mapping of keys to the paths this validation depends on. Keys can be used within a ValidationContext to access the value of the dependencies.

dependsOnDescendants

open val dependsOnDescendants: Boolean = false

Whether the form manager should reevaluate this validation whenever a descendant of the value being validated changes. This is false by default.

externalContextDependencies

open override val externalContextDependencies: Set<String>

Set of external context dependencies of the validation.

Functions

toString

open override fun toString(): String

validate

abstract fun ValidationContext.validate(): Flow<ValidationIssue>

Runs the validation within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.