kform/tech.ostack.kform/ValidationContext

ValidationContext

open class ValidationContext(value: Any?, schema: Schema<*>, val path: AbsolutePath, val schemaPath: AbsolutePath, val dependenciesInfo: DependenciesValueInfo, val externalContexts: ExternalContexts) : ComputationContext(source)

Context provided to a validation when running it, contains the values of the validation's dependencies at the time the validation was executed.

Constructors

ValidationContext

constructor(value: Any?, schema: Schema<*>, path: AbsolutePath, schemaPath: AbsolutePath, dependenciesInfo: DependenciesValueInfo, externalContexts: ExternalContexts)

Properties

dependenciesInfo

val dependenciesInfo: DependenciesValueInfo

Value information for each dependency of the computation. Mapping of keys as declared in the computation dependencies to their respective value information.

externalContexts

val externalContexts: ExternalContexts

path

val path: AbsolutePath

Path at which the computation is occurring.

schemaPath

val schemaPath: AbsolutePath

Path of the schema at which the computation is occurring.

Functions

dependency

fun <T> dependency(dependencyKey: String): T

Returns the value of the dependency with key dependencyKey.

dependencyInfo

fun <T> dependencyInfo(dependencyKey: String): ValueInfo<T>

Obtains the value information of the dependency with key dependencyKey.

dependencyInfoOrNull

fun <T> dependencyInfoOrNull(dependencyKey: String): ValueInfo<T>?

Obtains the value information of the dependency with key dependencyKey or null if the dependency could not be found in the form.

dependencyOrNull

fun <T> dependencyOrNull(dependencyKey: String): T?

Returns the value of the dependency with key dependencyKey or null if the dependency could not be found in the form.

dependencyPath

fun dependencyPath(dependencyKey: String): AbsolutePath

Returns the path of the dependency with key dependencyKey.

dependencyPathOrNull

fun dependencyPathOrNull(dependencyKey: String): AbsolutePath?

Returns the path of the dependency with key dependencyKey or null if the dependency could not be found in the form.

dependencySchema

fun <T> dependencySchema(dependencyKey: String): Schema<T>

Returns the schema of the dependency with key dependencyKey.

dependencySchemaOrNull

fun <T> dependencySchemaOrNull(dependencyKey: String): Schema<T>?

Returns the schema of the dependency with key dependencyKey or null if the dependency could not be found in the form.

externalContext

fun <T> externalContext(externalContextName: String): T

Returns the external context with name externalContextName available to the computation.

externalContextOrNull

fun <T> externalContextOrNull(externalContextName: String): T?

Returns the external context with name externalContextName available to the computation or null if the external context could not be found.

schema

fun <T> schema(): Schema<T>

Schema at which the computation is occurring.

value

fun <T> value(): T

Value being validated.