lithic-kotlin-root

lithic-kotlin-root/com.lithic.api.core/JsonField

JsonField

sealed class JsonField<out T : Any>

A class representing a serializable JSON field.

It can either be a KnownValue value of type T, matching the type the SDK expects, or an arbitrary JSON value that bypasses the type system (via JsonValue).

Inheritors

Types

object Companion

class Deserializer(type: JavaType? = null) : BaseDeserializer<JsonField<*>>

class IsMissing

This class is a Jackson filter that can be used to exclude missing properties from objects. This filter should not be used directly and should instead use the @ExcludeMissing annotation.

interface Visitor<in T, out R> : JsonValue.Visitor<R>

An interface that defines how to map each possible state of a JsonField<T> to a value of type R.

Functions

fun <R> accept(visitor: JsonField.Visitor<T, R>): R

Returns the result of calling the visitor method corresponding to this field's state.

fun asArray(): List<JsonValue>?

Returns this field's list value, or null if it doesn't contain a list.

fun asBoolean(): Boolean?

Returns this field's boolean value, or null if it doesn't contain a boolean.

fun asKnown(): T?

Returns this field's "known" value, meaning it matches the type the SDK expects, or null if this field contains an arbitrary JsonValue.

fun asNumber(): Number?

Returns this field's numerical value, or null if it doesn't contain a number.

fun asObject(): Map<String, JsonValue>?

Returns this field's map value, or null if it doesn't contain a map.

fun asString(): String?

Returns this field's string value, or null if it doesn't contain a string.

asStringOrThrow

fun asStringOrThrow(): String

fun asUnknown(): JsonValue?

Returns this field's arbitrary JsonValue, meaning it mismatches the type the SDK expects, or null if this field contains a "known" value.

fun isMissing(): Boolean

Returns whether this field is missing, which means it will be omitted from the serialized JSON entirely.

fun isNull(): Boolean

Whether this field is explicitly set to null.