components/dev.fritz2.components.validation

Package dev.fritz2.components.validation

Types

data class ComponentValidationMessage( val path: String, val severity: Severity, val message: String, val details: String? = null) : ValidationMessage

Special ValidationMessage for fritz2 components.

ComponentValidator

abstract class ComponentValidator<D, T> : Validator<D, ComponentValidationMessage, T>

Special Validator for fritz2 components which uses the ComponentValidationMessage internally.

Severity

enum Severity : Enum<Severity>

Enum which specify the Severity of ComponentValidationMessage.

WithValidator

interface WithValidator<D, T> : Store<D>

Interface which RootStores can implement to mark them that they have a ComponentValidator. Then all SubStores can evaluate if a ComponentValidationMessage is available for their field.

Functions

errorMessage

fun <T> Inspector<T>.errorMessage(message: String, details: String? = null): ComponentValidationMessage

fun errorMessage( path: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Error.

infoMessage

fun <T> Inspector<T>.infoMessage(message: String, details: String? = null): ComponentValidationMessage

fun infoMessage( path: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Info.

successMessage

fun <T> Inspector<T>.successMessage(message: String, details: String? = null): ComponentValidationMessage

fun successMessage( path: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Info.

validationMessage

fun <D> Store<D>.validationMessage(): Flow<ComponentValidationMessage?>?

Finds the proper ComponentValidationMessage for the given Store.

validationMessages

fun <D> Store<D>.validationMessages(): Flow<List<ComponentValidationMessage>>?

Filters all proper ComponentValidationMessages for the given Store.

warningMessage

fun <T> Inspector<T>.warningMessage(message: String, details: String? = null): ComponentValidationMessage

fun warningMessage( path: String, message: String, details: String? = null): ComponentValidationMessage

Creates ComponentValidationMessage with Severity.Warning.