http4k-core/org.http4k.lens/BiDiLensSpec

BiDiLensSpec

open class BiDiLensSpec<IN : Any, OUT>(location: String, paramMeta: ParamMeta, get: LensGet<IN, OUT>, set: LensSet<IN, OUT>) : LensSpec<IN, OUT> , BiDiLensBuilder<IN, OUT>

Represents a bi-directional extraction of an entity from a target, or an insertion into a target.

Inheritors

Header

Query

FormField

Constructors

BiDiLensSpec

constructor(location: String, paramMeta: ParamMeta, get: LensGet<IN, OUT>, set: LensSet<IN, OUT>)

Properties

location

val location: String

multi

open override val multi: BiDiMultiLensSpec<IN, OUT>

Functions

base64

fun <IN : Any> BiDiLensSpec<IN, String>.base64(): BiDiLensSpec<IN, String>

basicCredentials

fun <IN : Any> BiDiLensSpec<IN, String>.basicCredentials(): BiDiLensSpec<IN, Credentials>

bigDecimal

fun <IN : Any> BiDiLensSpec<IN, String>.bigDecimal(): BiDiLensSpec<IN, BigDecimal>

bigInteger

fun <IN : Any> BiDiLensSpec<IN, String>.bigInteger(): BiDiLensSpec<IN, BigInteger>

boolean

fun <IN : Any> BiDiLensSpec<IN, String>.boolean(): BiDiLensSpec<IN, Boolean>

bytes

fun <IN : Any> BiDiLensSpec<IN, String>.bytes(): LensSpec<IN, ByteArray>

composite

inline fun <TARGET : Any, T> BiDiLensSpec<TARGET, String>.composite(crossinline fn: BiDiLensSpec<TARGET, String>.(TARGET) -> T): Lens<TARGET, T>

This allows creation of a composite object from several values from the same source.

inline fun <TARGET : Any, T> BiDiLensSpec<TARGET, String>.composite(crossinline getFn: BiDiLensSpec<TARGET, String>.(TARGET) -> T, crossinline setFn: T.(TARGET) -> TARGET): BiDiLens<TARGET, T>

csv

fun <IN : Any> BiDiLensSpec<IN, String>.csv(delimiter: String = ","): BiDiLensSpec<IN, List<String>>

fun <IN : Any, T : Any> BiDiLensSpec<IN, String>.csv(delimiter: String = ",", mapElement: BiDiMapping<String, T>): BiDiLensSpec<IN, List<T>>

dateTime

fun <IN : Any> BiDiLensSpec<IN, String>.dateTime(formatter: DateTimeFormatter = ISO_LOCAL_DATE_TIME): BiDiLensSpec<IN, LocalDateTime>

defaulted

open override fun defaulted(name: String, default: OUT, description: String?, metadata: Map<String, Any>): BiDiLens<IN, OUT>

Make a concrete Lens for this spec that falls back to the default value if no value is found in the target.

open override fun defaulted(name: String, default: LensExtractor<IN, OUT>, description: String?, metadata: Map<String, Any>): BiDiLens<IN, OUT>

Make a concrete Lens for this spec that falls back to another lens if no value is found in the target.

double

fun <IN : Any> BiDiLensSpec<IN, String>.double(): BiDiLensSpec<IN, Double>

duration

fun <IN : Any> BiDiLensSpec<IN, String>.duration(): BiDiLensSpec<IN, Duration>

enum

inline fun <IN : Any, T : Enum<T>> BiDiLensSpec<IN, String>.enum(): BiDiLensSpec<IN, T>

inline fun <T : Enum<T>> BiDiLensSpec<WebForm, String>.enum(): BiDiLensSpec<WebForm, T>

inline fun <IN : Any, T : Enum<T>> BiDiLensSpec<IN, String>.enum(noinline nextOut: (String) -> T, noinline nextIn: (T) -> String): BiDiLensSpec<IN, T>

float

fun <IN : Any> BiDiLensSpec<IN, String>.float(): BiDiLensSpec<IN, Float>

instant

fun <IN : Any> BiDiLensSpec<IN, String>.instant(): BiDiLensSpec<IN, Instant>

int

fun <IN : Any> BiDiLensSpec<IN, String>.int(): BiDiLensSpec<IN, Int>

localDate

fun <IN : Any> BiDiLensSpec<IN, String>.localDate(formatter: DateTimeFormatter = ISO_LOCAL_DATE): BiDiLensSpec<IN, LocalDate>

locale

fun <IN : Any> BiDiLensSpec<IN, String>.locale(): BiDiLensSpec<IN, Locale>

localTime

fun <IN : Any> BiDiLensSpec<IN, String>.localTime(formatter: DateTimeFormatter = ISO_LOCAL_TIME): BiDiLensSpec<IN, LocalTime>

long

fun <IN : Any> BiDiLensSpec<IN, String>.long(): BiDiLensSpec<IN, Long>

map

fun <NEXT> map(nextIn: (OUT) -> NEXT, nextOut: (NEXT) -> OUT): BiDiLensSpec<IN, NEXT>

Create another BiDiLensSpec which applies the bi-directional transformations to the result. Any resultant Lens can be used to extract or insert the final type from/into a target.

fun <NEXT> map(nextIn: (OUT) -> NEXT): LensSpec<IN, NEXT>

Create another LensSpec which applies the uni-directional transformation to the result. Any resultant Lens can only be used to extract the final type from a target.

map

fun <NEXT, IN : Any, OUT> BiDiLensSpec<IN, OUT>.map(mapping: BiDiMapping<OUT, NEXT>): BiDiLensSpec<IN, NEXT>

mapWithNewMeta

fun <NEXT> mapWithNewMeta(nextIn: (OUT) -> NEXT, nextOut: (NEXT) -> OUT, paramMeta: ParamMeta): BiDiLensSpec<IN, NEXT>

mapWithNewMeta

fun <NEXT, IN : Any, OUT> BiDiLensSpec<IN, OUT>.mapWithNewMeta(mapping: BiDiMapping<OUT, NEXT>, paramMeta: ParamMeta): BiDiLensSpec<IN, NEXT>

nonBlankString

fun <IN : Any> BiDiLensSpec<IN, String>.nonBlankString(): BiDiLensSpec<IN, String>

nonEmptyString

fun <IN : Any> BiDiLensSpec<IN, String>.nonEmptyString(): BiDiLensSpec<IN, String>

offsetDateTime

fun <IN : Any> BiDiLensSpec<IN, String>.offsetDateTime(formatter: DateTimeFormatter = ISO_OFFSET_DATE_TIME): BiDiLensSpec<IN, OffsetDateTime>

offsetTime

fun <IN : Any> BiDiLensSpec<IN, String>.offsetTime(formatter: DateTimeFormatter = ISO_OFFSET_TIME): BiDiLensSpec<IN, OffsetTime>

optional

open override fun optional(name: String, description: String?, metadata: Map<String, Any>): BiDiLens<IN, OUT?>

Make a concrete Lens for this spec that looks for an optional value in the target.

regex

fun <IN : Any> BiDiLensSpec<IN, String>.regex(pattern: String, group: Int = 1): BiDiLensSpec<IN, String>

regexObject

fun <IN : Any> BiDiLensSpec<IN, String>.regexObject(): BiDiLensSpec<IN, Regex>

required

open override fun required(name: String, description: String?, metadata: Map<String, Any>): BiDiLens<IN, OUT>

Make a concrete Lens for this spec that looks for a required value in the target.

string

fun <IN : Any> BiDiLensSpec<IN, String>.string(): BiDiLensSpec<IN, String>

uri

fun <IN : Any> BiDiLensSpec<IN, String>.uri(): BiDiLensSpec<IN, Uri>

urlEncoded

fun <IN : Any> BiDiLensSpec<IN, String>.urlEncoded(): BiDiLensSpec<IN, String>

uuid

fun <IN : Any> BiDiLensSpec<IN, String>.uuid(): BiDiLensSpec<IN, UUID>

value

fun <M : Any, VALUE : Value<T>, T : Any> BiDiLensSpec<M, String>.value(vf: ValueFactory<VALUE, T>): BiDiLensSpec<M, VALUE>

Custom lens for mapping to values4k Value

yearMonth

fun <IN : Any> BiDiLensSpec<IN, String>.yearMonth(): BiDiLensSpec<IN, YearMonth>

zonedDateTime

fun <IN : Any> BiDiLensSpec<IN, String>.zonedDateTime(formatter: DateTimeFormatter = ISO_ZONED_DATE_TIME): BiDiLensSpec<IN, ZonedDateTime>

zoneId

fun <IN : Any> BiDiLensSpec<IN, String>.zoneId(): BiDiLensSpec<IN, ZoneId>

zoneOffset

fun <IN : Any> BiDiLensSpec<IN, String>.zoneOffset(): BiDiLensSpec<IN, ZoneOffset>