api

http4k / org.http4k.format / AutoMappingConfiguration

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).

Functions

Name	Summary
bigDecimal	abstract fun <OUT> bigDecimal(mapping: BiDiMapping<BigDecimal, OUT>): AutoMappingConfiguration<BUILDER>
bigInteger	abstract fun <OUT> bigInteger(mapping: BiDiMapping<BigInteger, OUT>): AutoMappingConfiguration<BUILDER>
boolean	abstract fun <OUT> boolean(mapping: BiDiMapping<Boolean, OUT>): AutoMappingConfiguration<BUILDER>
done	Finalise the mapping configurations.abstract fun done(): BUILDER
double	abstract fun <OUT> double(mapping: BiDiMapping<Double, OUT>): AutoMappingConfiguration<BUILDER>
int	abstract fun <OUT> int(mapping: BiDiMapping<Int, OUT>): AutoMappingConfiguration<BUILDER>
long	abstract fun <OUT> long(mapping: BiDiMapping<Long, OUT>): AutoMappingConfiguration<BUILDER>
prohibitStrings	Prevent the unmarshalling of raw (unbounded) strings. Useful when we are taking data from the Internet and want to ensure that all inbound fields are represented by bounded or validated types.open fun prohibitStrings(): AutoMappingConfiguration<BUILDER>
text	abstract fun <OUT> text(mapping: BiDiMapping<String, OUT>): AutoMappingConfiguration<BUILDER>

Extension Functions

Name	Summary
bigDecimal	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.bigDecimal(inFn: (BigDecimal) -> OUT, outFn: (OUT) -> BigDecimal): AutoMappingConfiguration<BUILDER>
bigInteger	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.bigInteger(inFn: (BigInteger) -> OUT, outFn: (OUT) -> BigInteger): AutoMappingConfiguration<BUILDER>
boolean	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.boolean(inFn: (Boolean) -> OUT, outFn: (OUT) -> Boolean): AutoMappingConfiguration<BUILDER>
double	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.double(outFn: (OUT) -> Double, inFn: (Double) -> OUT): AutoMappingConfiguration<BUILDER>
duration	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.duration(inFn: (Duration) -> OUT, outFn: (OUT) -> Duration): AutoMappingConfiguration<BUILDER>
instant	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.instant(inFn: (Instant) -> OUT, outFn: (OUT) -> Instant): AutoMappingConfiguration<BUILDER>
int	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.int(inFn: (Int) -> OUT, outFn: (OUT) -> Int): AutoMappingConfiguration<BUILDER>
localDate	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localDate(inFn: (LocalDate) -> OUT, outFn: (OUT) -> LocalDate): AutoMappingConfiguration<BUILDER>
localDateTime	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localDateTime(inFn: (LocalDateTime) -> OUT, outFn: (OUT) -> LocalDateTime): AutoMappingConfiguration<BUILDER>
localTime	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.localTime(inFn: (LocalTime) -> OUT, outFn: (OUT) -> LocalTime): AutoMappingConfiguration<BUILDER>
long	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.long(inFn: (Long) -> OUT, outFn: (OUT) -> Long): AutoMappingConfiguration<BUILDER>
offsetDateTime	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.offsetDateTime(inFn: (OffsetDateTime) -> OUT, outFn: (OUT) -> OffsetDateTime): AutoMappingConfiguration<BUILDER>
offsetTime	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.offsetTime(inFn: (OffsetTime) -> OUT, outFn: (OUT) -> OffsetTime): AutoMappingConfiguration<BUILDER>
text	This is the set of utility methods which avoid the noise of creating a BiDiMapping when specifying mappings.fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(inFn: (String) -> OUT, outFn: (OUT) -> String): AutoMappingConfiguration<BUILDER> Utility method for when only writing/serialization is requiredfun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(mapping: (OUT) -> String): AutoMappingConfiguration<BUILDER> Utility method for when only reading/deserialization is requiredfun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.text(mapping: (String) -> OUT): AutoMappingConfiguration<BUILDER>
uri	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.uri(inFn: (Uri) -> OUT, outFn: (OUT) -> Uri): AutoMappingConfiguration<BUILDER>
uuid	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.uuid(inFn: (UUID) -> OUT, outFn: (OUT) -> UUID): AutoMappingConfiguration<BUILDER>
withStandardMappings	This is the set of (additional) standardised string <-> type mappings which http4k supports out of the box.fun <T> AutoMappingConfiguration<T>.withStandardMappings(): AutoMappingConfiguration<T>
yearMonth	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.yearMonth(inFn: (YearMonth) -> OUT, outFn: (OUT) -> YearMonth): AutoMappingConfiguration<BUILDER>
zonedDateTime	fun <BUILDER, OUT> AutoMappingConfiguration<BUILDER>.zonedDateTime(inFn: (ZonedDateTime) -> OUT, outFn: (OUT) -> ZonedDateTime): AutoMappingConfiguration<BUILDER>