Package dev.fritz2.lenses

Types

IdProvider

common

typealias IdProvider<T, I> = (T) -> I

function to derive a valid id for a given instance that does not change over time.

Lens

common

interface Lens<P, T>

Describes a focus point into a data structure, i.e.

Lenses

common

@Target(allowedTargets = [AnnotationTarget.CLASS])

annotation class Lenses

Used by the fritz2 gradle-plugin to identify data classes it should generate Lenses for.

LensException

common

class LensException : Exception

Occurs when Lens points to non existing element.

Functions

asString

fun Lens<P, Boolean>.asString(): Lens<P, String>

Creates a Lens from Boolean to String

fun Lens<P, Byte>.asString(): Lens<P, String>

Creates a Lens from Byte to String

fun Lens<P, Double>.asString(): Lens<P, String>

Creates a Lens from Double to String

fun Lens<P, Float>.asString(): Lens<P, String>

Creates a Lens from Float to String

fun Lens<P, Int>.asString(): Lens<P, String>

Creates a Lens from Int to String

fun Lens<P, Long>.asString(): Lens<P, String>

Creates a Lens from Long to String

fun Lens<P, Short>.asString(): Lens<P, String>

Creates a Lens from Short to String

fun Lens<P, Boolean?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Boolean to String

fun Lens<P, Byte?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Byte to String

fun Lens<P, Double?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Double to String

fun Lens<P, Float?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Float to String

fun Lens<P, Int?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Int to String

fun Lens<P, Long?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Long to String

fun Lens<P, Short?>.asString(emptyValue: String = ""): Lens<P, String>

Creates a Lens from Short to String

fun Lens<P, List<Byte>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Byte to String

fun Lens<P, List<Double>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Double to String

fun Lens<P, List<Float>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Float to String

fun Lens<P, List<Int>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Int to String

fun Lens<P, List<Long>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Long to String

fun Lens<P, List<Short>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of Short to String

fun Lens<P, List<String>>.asString(separator: String = ", ", prefix: String = "", postfix: String = ""): Lens<P, String>

Creates a Lens from List of String to String

buildLens

common

inline fun <P, T> buildLens(id: String, crossinline getter: (P) -> T, crossinline setter: (P, T) -> P): Lens<P, T>

convenience function to create a Lens

elementLens

common

fun <T, I> elementLens(element: T, idProvider: IdProvider<T, I>): Lens<List<T>, T>

creates a Lens pointing to a certain element in a list

format

common

inline fun format(crossinline parse: (String) -> P, crossinline format: (P) -> String): Lens<P, String>

creates a Lens converting P to and from a String

positionLens

common

fun <T> positionLens(index: Int): Lens<List<T>, T>

creates a Lens pointing to a certain position in a list