kform/tech.ostack.kform.validations/MaxSize

MaxSize

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

Validation that checks that a value's size is at most a given maxSize. Values of type Collection, Array (including variants), Map, Table, and File are supported.

When the size of the value being validated is greater than maxSize, 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 maxSize data property with the value of maxSize.

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

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

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

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

Constructors

MaxSize

@JvmOverloads

constructor(maxSize: 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's size is greater than maxSize.

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.

maxSize

val maxSize: Int

Maximum size allowed.

severity

val severity: ValidationIssueSeverity

Severity of the issue emitted when the value's size is greater than maxSize.

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.