kform/tech.ostack.kform.validations/MustEqual

MustEqual

open class MustEqual<T> @JvmOverloads constructor(val requiredValue: T, val code: String = DEFAULT_CODE, val severity: ValidationIssueSeverity = ValidationIssueSeverity.Error) : Validation<T> (source)

Validation that checks that a value equals a given requiredValue.

When the value being validated is different from requiredValue, then an issue is emitted with the provided code (defaults to DEFAULT_CODE). This issue contains a value data property with the value that was validated and a requiredValue data property with the value of requiredValue.

Constructors

MustEqual

@JvmOverloads

constructor(requiredValue: T, code: String = DEFAULT_CODE, severity: ValidationIssueSeverity = ValidationIssueSeverity.Error)

Types

Companion

object Companion

Properties

code

val code: String

Issue code to use when the value is different from requiredValue.

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

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.

requiredValue

val requiredValue: T

Value to equal.

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the value is different from requiredValue.

Functions

toString

open override fun toString(): String

validate

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