kform/tech.ostack.kform.validations/Size

Size

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

Validation that checks that a value's size is exactly requiredSize, when it is not empty. Values of type Collection, Array (including variants), Map, Table, and File are supported.

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

To also validate that a value is not empty, use Required (preferred) or NotEmpty (if the value is nullable and null is an acceptable value) together with Size.

Example values accepted by schema ListSchema(Size(4)) { IntSchema() }:

listOf(1, 2, 3, 4)
emptyList()

Example values rejected by schema ListSchema(Size(4)) { IntSchema() }:

listOf(1, 2, 3)
listOf(1, 2, 3, 4, 5)

Constructors

Size

@JvmOverloads

constructor(requiredSize: Int, 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 not empty and its size is different from requiredSize.

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.

requiredSize

val requiredSize: Int

Expected size of the value (must be >= 0).

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the value is not empty and its size is different from requiredSize.

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.