http4k-format-core/org.http4k.format

Package-level declarations

Types

class AutoContentNegotiator<T>(defaultLens: BiDiBodyLens<T>, alternateLenses: List<BiDiBodyLens<T>>) : Iterable<BiDiBodyLens<T>> , LensExtractor<HttpMessage, T>

AutoMappingConfiguration

interface AutoMappingConfiguration<BUILDER>

This is the generic interface used to configure auto-mapping functionality for message format libraries. The various methods here can be used to provide custom mapping behaviour (say for domain classes).

AutoMarshalling

abstract class AutoMarshalling

Common base type for all format libraries which can convert directly from String -> Classes

AutoMarshallingJson

abstract class AutoMarshallingJson<NODE : Any> : AutoMarshalling, Json<NODE>

AutoMarshallingXml

abstract class AutoMarshallingXml : AutoMarshalling

Json

interface Json<NODE>

This is the contract for all JSON implementations

JsonType

enum JsonType : Enum<JsonType>

Functions

auto

fun <T> ContentNegotiation.Companion.auto(defaultLens: BiDiBodyLens<T>, vararg lenses: BiDiBodyLens<T>): AutoContentNegotiator<T>

bigDecimal

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.bigDecimal(noinline inFn: (BigDecimal) -> OUT, noinline outFn: (OUT) -> BigDecimal): AutoMappingConfiguration<BUILDER>

bigInteger

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.bigInteger(noinline inFn: (BigInteger) -> OUT, noinline outFn: (OUT) -> BigInteger): AutoMappingConfiguration<BUILDER>

boolean

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.boolean(noinline inFn: (Boolean) -> OUT, noinline outFn: (OUT) -> Boolean): AutoMappingConfiguration<BUILDER>

double

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.double(noinline outFn: (OUT) -> Double, noinline inFn: (Double) -> OUT): AutoMappingConfiguration<BUILDER>

duration

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.duration(noinline inFn: (Duration) -> OUT, noinline outFn: (OUT) -> Duration): AutoMappingConfiguration<BUILDER>

httpBodyLens

fun httpBodyLens(description: String? = null, contentNegotiation: ContentNegotiation = None, contentType: ContentType): BiDiBodyLensSpec<String>

instant

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.instant(noinline inFn: (Instant) -> OUT, noinline outFn: (OUT) -> Instant): AutoMappingConfiguration<BUILDER>

int

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.int(noinline inFn: (Int) -> OUT, noinline outFn: (OUT) -> Int): AutoMappingConfiguration<BUILDER>

localDate

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localDate(noinline inFn: (LocalDate) -> OUT, noinline outFn: (OUT) -> LocalDate): AutoMappingConfiguration<BUILDER>

localDateTime

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localDateTime(noinline inFn: (LocalDateTime) -> OUT, noinline outFn: (OUT) -> LocalDateTime): AutoMappingConfiguration<BUILDER>

localTime

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localTime(noinline inFn: (LocalTime) -> OUT, noinline outFn: (OUT) -> LocalTime): AutoMappingConfiguration<BUILDER>

long

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.long(noinline inFn: (Long) -> OUT, noinline outFn: (OUT) -> Long): AutoMappingConfiguration<BUILDER>

offsetDateTime

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.offsetDateTime(noinline inFn: (OffsetDateTime) -> OUT, noinline outFn: (OUT) -> OffsetDateTime): AutoMappingConfiguration<BUILDER>

offsetTime

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.offsetTime(noinline inFn: (OffsetTime) -> OUT, noinline outFn: (OUT) -> OffsetTime): AutoMappingConfiguration<BUILDER>

text

@JvmName(name = "textSerialize")

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(noinline mapping: (OUT) -> String): AutoMappingConfiguration<BUILDER>

Utility method for when only writing/serialization is required

@JvmName(name = "textDeserialize")

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(noinline mapping: (String) -> OUT): AutoMappingConfiguration<BUILDER>

Utility method for when only reading/deserialization is required

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(noinline inFn: (String) -> OUT, noinline outFn: (OUT) -> String): AutoMappingConfiguration<BUILDER>

This is the set of utility methods which avoid the noise of creating a BiDiMapping when specifying mappings.

uri

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.uri(noinline inFn: (Uri) -> OUT, noinline outFn: (OUT) -> Uri): AutoMappingConfiguration<BUILDER>

uuid

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.uuid(noinline inFn: (UUID) -> OUT, noinline outFn: (OUT) -> UUID): AutoMappingConfiguration<BUILDER>

value

@JvmName(name = "stringMapper")

inline fun <BUILD, VALUE : Value<T>, T : Any> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, T>): AutoMappingConfiguration<BUILD>

@JvmName(name = "bigDecimal")

inline fun <BUILD, VALUE : Value<BigDecimal>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, BigDecimal>): AutoMappingConfiguration<BUILD>

@JvmName(name = "bigIntegerMapper")

inline fun <BUILD, VALUE : Value<BigInteger>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, BigInteger>): AutoMappingConfiguration<BUILD>

@JvmName(name = "booleanMapper")

inline fun <BUILD, VALUE : Value<Boolean>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, Boolean>): AutoMappingConfiguration<BUILD>

@JvmName(name = "doubleMapper")

inline fun <BUILD, VALUE : Value<Double>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, Double>): AutoMappingConfiguration<BUILD>

@JvmName(name = "intMapper")

inline fun <BUILD, VALUE : Value<Int>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, Int>): AutoMappingConfiguration<BUILD>

@JvmName(name = "longMapper")

inline fun <BUILD, VALUE : Value<Long>> AutoMappingConfiguration<BUILD>.value(fn: ValueFactory<VALUE, Long>): AutoMappingConfiguration<BUILD>

withStandardMappings

fun <T> AutoMappingConfiguration<T>.withStandardMappings(): AutoMappingConfiguration<T>

This is the set of (additional) standardised string <-> type mappings which http4k supports out of the box.

yearMonth

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.yearMonth(noinline inFn: (YearMonth) -> OUT, noinline outFn: (OUT) -> YearMonth): AutoMappingConfiguration<BUILDER>

zonedDateTime

inline fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.zonedDateTime(noinline inFn: (ZonedDateTime) -> OUT, noinline outFn: (OUT) -> ZonedDateTime): AutoMappingConfiguration<BUILDER>