kform/tech.ostack.kform.validations/NotEmpty

NotEmpty

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

Validation that checks that a value is not empty. Values of type String, Collection, Array (and variants), Map, Table, and File are supported.

When the value being validated is empty, then an issue is emitted with the provided code (defaults to DEFAULT_CODE).

The Required validation should be preferred over this validation to semantically signal that a value is required. Otherwise, this validation should be used when:

The value is nullable and null values are accepted, but not empty values.
The value is a File and empty files should not be accepted, since Required does not forbid empty files. To forbid both the null value and empty files, use Required together with NotEmpty.

Parameters

code

Issue code to use when the value is empty.

severity

Severity of the issue emitted when the value is empty.

Constructors

NotEmpty

@JvmOverloads

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

Types

Companion

object Companion

Properties

code

val code: String

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.

severity

val severity: ValidationIssueSeverity

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.