kairo-serialization/kairo.serialization/KairoJson

KairoJson

A wrapper around Jackson's JsonMapper.

Has stricter and less surprising defaults than native Jackson, but you can still override them the same way you would for Jackson.

Serialization and deserialization retain type information, reducing surprises like polymorphic type information not being included when serializing the type directly.

Supports Kotlin's nullability guarantees.

Types

Builder

class Builder

RawJsonMapper

@Target(allowedTargets = [AnnotationTarget.CONSTRUCTOR, AnnotationTarget.PROPERTY])

annotation class RawJsonMapper

You must opt in to access the raw JsonMapper.

Properties

delegate

val delegate: JsonMapper

Functions

checkResult

fun <T> checkResult(result: T?, type: KairoType<T>)

Ensures that the result matches the expected type. The primary purpose is shim support for Kotlin's nullability guarantees.

copy

fun copy(configure: JsonMapper.Builder.() -> Unit): KairoJson

deserialize

inline fun <T> deserialize(string: String): T

fun <T> deserialize(string: String, type: KairoType<T>): T

inputStream

inline fun <T> inputStream(inputStream: InputStream): T

fun <T> inputStream(inputStream: InputStream, type: KairoType<T>): T

jsonGenerator

inline fun <T> KairoJson.jsonGenerator(jsonGenerator: JsonGenerator, value: T?)

fun <T> KairoJson.jsonGenerator(jsonGenerator: JsonGenerator, value: T?, type: KairoType<T>)

outputStream

inline fun <T> outputStream(outputStream: OutputStream, value: T?)

fun <T> outputStream(outputStream: OutputStream, value: T?, type: KairoType<T>)

reader

inline fun <T> KairoJson.reader(reader: Reader): T

fun <T> KairoJson.reader(reader: Reader, type: KairoType<T>): T

serialize

inline fun <T> serialize(value: T?): String

fun <T> serialize(value: T?, type: KairoType<T>): String