kform/tech.ostack.kform.validations/ScopedSyncValidation

ScopedSyncValidation

abstract class ScopedSyncValidation<in T, TScope> @JvmOverloads constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME) : ScopedJvmValidation<T, TScope>

Synchronous scoped validation more easily implementable from Java.

Constructors

@JvmOverloads

constructor(scopeExternalContextName: String = DEFAULT_SCOPE_EXTERNAL_CONTEXT_NAME)

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 override var dependsOnDescendants: Boolean

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.

schema

protected val ValidationContext.schema: Schema<T>

Schema of the value being validated.

scope

protected val ValidationContext.scope: TScope?

Current validation scope.

scopes

open lateinit override var scopes: ValidationScopes<TScope>

Validation scopes of this validation.

value

protected val ValidationContext.value: T

Value being validated.

Functions

addDependency

@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.

addExternalContextDependency

protected fun addExternalContextDependency(externalContextName: String)

Declares an external context dependency to externalContextName.

dependency

protected inline fun <TDependency> dependency(path: String, dependencyKey: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TDependency>>

protected inline fun <TDependency> dependency(path: Path, dependencyKey: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TDependency>>

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

dependencyOrNull

protected inline fun <TDependency> dependencyOrNull(path: String, dependencyKey: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TDependency?>>

protected inline fun <TDependency> dependencyOrNull(path: Path, dependencyKey: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TDependency?>>

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

externalContext

protected fun <TContext> externalContext(externalContextName: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TContext>>

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

externalContextOrNull

protected fun <TContext> externalContextOrNull(externalContextName: String?): PropertyDelegateProvider<Validation<T>, ReadOnlyProperty<ValidationContext, TContext?>>

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

scopedValidate

override fun ValidationContext.scopedValidate(): Flow<ValidationIssue>

Runs the scoped validation (when the current "validation scope" is allowed by the provided scopes) within a ValidationContext containing the value being validated and the value of all declared dependencies. Returns a flow over all found issues.

abstract fun scopedValidate(context: ValidationContext, issues: MutableList<ValidationIssue>)

Synchronous implementation of ValidationContext.scopedValidate. Validation issues should be added to issues.

toString

open override fun toString(): String

validate

override 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.