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

JsonValue

sealed class JsonValue : JsonField<Nothing>

A class representing an arbitrary JSON value.

It is immutable and assignable to any JsonField, regardless of its expected type (i.e. its generic type argument).

Inheritors

Types

Companion

object Companion

Deserializer

class Deserializer : BaseDeserializer<JsonValue>

Visitor

interface Visitor<out R>

An interface that defines how to map each variant state of a JsonValue to a value of type R.

Functions

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

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

fun <R> accept(visitor: JsonValue.Visitor<R>): R

Returns the result of calling the visitor method corresponding to this value's variant.

asArray

fun asArray(): List<JsonValue>?

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

asBoolean

fun asBoolean(): Boolean?

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

asKnown

fun asKnown(): Nothing?

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

asNumber

fun asNumber(): Number?

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

asObject

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

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

asString

fun asString(): String?

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

asStringOrThrow

fun asStringOrThrow(): String

asUnknown

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.

convert

inline fun <R : Any> convert(): R?

fun <R : Any> convert(type: TypeReference<R>): R?

fun <R : Any> convert(type: KClass<R>): R?

isMissing

fun isMissing(): Boolean

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

isNull

fun isNull(): Boolean

Whether this field is explicitly set to null.