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

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard

Set of external context dependencies of the validation.

Link copied to clipboard

Schema of the value being validated.

Link copied to clipboard
protected val ValidationContext.value: T

Value being validated.

Functions

Link copied to clipboard
@JvmName(name = "reifiedAddDependency")
protected inline fun <TDependency> addDependency(dependencyKey: String, path: String)
protected fun addDependency(dependencyKey: String, path: String)
@JvmName(name = "reifiedAddDependency")
protected inline fun <TDependency> addDependency(dependencyKey: String, path: Path)
protected fun addDependency(dependencyKey: String, path: Path)

Declares a dependency to path, accessible in the validation's context via key dependencyKey.

Link copied to clipboard
protected fun addExternalContextDependency(externalContextName: String)

Declares an external context dependency to externalContextName.

Link copied to clipboard

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

Link copied to clipboard

Function used to declare a dependency to a path and delegate access to its value within a ValidationContext.

Link copied to clipboard

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

Link copied to clipboard

Function used to declare a dependency to an external context and delegate access to its value within a ValidationContext.

Link copied to clipboard
open override fun toString(): String
Link copied to clipboard

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.