Validator

abstract class Validator<D, M : ValidationMessage, T>

Describes the logic for validating a given data-model. By implementing this you must describe, how a certain data-model should be validated. This is done by returning a List of ValidationMessages in the validate functions.

It is recommended to put the concrete implementation of this Validator right next to your data classes in the commonMain section of your Kotlin multiplatform project. Then you can write the validation logic once and use them in the JS and JVM world.

Constructors

Validator

fun Validator()

Functions

filter

fun filter(predicate: (M) -> Boolean): Flow<List<M>>

Returns a Flow of list containing only ValidationMessages matching the given predicate.

find

fun find(predicate: (M) -> Boolean): Flow<M?>

Finds the first ValidationMessage matching the given predicate.

isValid

fun isValid(data: D, metadata: T): Boolean

validates the given model by using the validate functions which must be implemented with the validation rules.

jvm

fun isValid(data: D, metadata: T): Boolean

evaluates the List of ValidationMessage to see if your data is valid or not

reset

fun reset(messages: List<M> = emptyList())

Resets the validation result.

jvm

fun reset(messages: List<M> = emptyList())

Resets the validation result.

validate

common

fun validate(data: D, metadata: T): List<M>

validates the given data by using the given metadata and returns a List of ValidationMessages.

fun validate(data: D, metadata: T): List<M>

validates the given data by using the given metadata and returns a List of ValidationMessages.

jvm

fun validate(data: D, metadata: T): List<M>

validates the given data by using the given metadata and returns a List of ValidationMessages.

common

abstract fun validate(inspector: Inspector<D>, metadata: T): List<M>

validates the given inspector and it's containing data by using the given metadata and returns a List of ValidationMessages.

abstract fun validate(inspector: Inspector<D>, metadata: T): List<M>

validates the given inspector and it's containing data by using the given metadata and returns a List of ValidationMessages.

jvm

abstract fun validate(inspector: Inspector<D>, metadata: T): List<M>

validates the given inspector and it's containing data by using the given metadata and returns a List of ValidationMessages.

Properties

current

val current: List<M>

Represents the current List of ValidationMessages.

current

jvm

val current: List<M>

Represents the current List of ValidationMessages.

data

val data: Flow<List<M>>

Gives a Flow of ValidationMessages which gets updated every time when isValid gets called.

isValid

val isValid: Flow<Boolean>

A Flow representing the current state of the model (valid or not).