kform/tech.ostack.kform.validations/Length

Length

open class Length @JvmOverloads constructor(val requiredLength: Int, val code: String = DEFAULT_CODE, val severity: ValidationIssueSeverity = ValidationIssueSeverity.Error) : Validation<CharSequence> (source)

Validation that checks that a string's length is exactly requiredLength, when it is not empty.

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

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

Example values accepted by schema StringSchema(Length(4)):

"abcd"
""

Example values rejected by schema StringSchema(Length(4)):

"abc"
"abcde"

Constructors

Length

@JvmOverloads

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

Types

Companion

object Companion

Properties

code

val code: String

Issue code to use when the string is not empty and its length is different from requiredLength.

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.

requiredLength

val requiredLength: Int

Required length for non-empty strings (must be >= 0).

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the string is not empty and its length is different from requiredLength.

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.