core/dev.fritz2.core/RootInspector

RootInspector

class RootInspector<T>(val data: T) : Inspector<T>

RootInspector is the starting point for getting your data and corresponding paths from your deep nested model structure. Get this by calling the factory method inspectorOf.

Inspector is useful in validation process to know which model attribute is not valid.

Constructors

RootInspector

constructor(data: T)

Properties

data

open override val data: T

D representation of stored data

path

open override val path: String

String representation of the corresponding path in model

Functions

inspectEach

fun <D> Inspector<List<D>>.inspectEach(action: (Inspector<D>) -> Unit)

fun <K, V> Inspector<Map<K, V>>.inspectEach(action: (K, Inspector<V>) -> Unit)

fun <D, I> Inspector<List<D>>.inspectEach(idProvider: IdProvider<D, I>, action: (Inspector<D>) -> Unit)

Performs the given action on each Inspector.

map

open fun <X> map(lens: Lens<T, X>): Inspector<X>

creates a new Inspector for a part of your underlying data-model

mapByElement

fun <D, I> Inspector<List<D>>.mapByElement(element: D, idProvider: IdProvider<D, I>): Inspector<D>

Creates a new Inspector containing the element for the given element and idProvider from the original Inspector's List.

mapByIndex

fun <D> Inspector<List<D>>.mapByIndex(index: Int): Inspector<D>

Creates a new Inspector containing the element for the given index from the original Inspector's List

mapByKey

fun <K, V> Inspector<Map<K, V>>.mapByKey(key: K): Inspector<V>

Creates a new Inspector containing the value for the given key from the original Inspector's Map

mapNull

fun <D> Inspector<D?>.mapNull(default: D): Inspector<D>

Creates a new Inspector from a nullable parent inspector that either contains the original value or a given default value if the original value was null.

mapNullable

fun <T> Inspector<T>.mapNullable(placeholder: T): Inspector<T?>

Creates a new Inspector from a non-nullable parent inspector that either contains the original value or null if its value matches the given placeholder.