MapJsonAdapter

Converts maps with string keys to JSON objects.

TODO: support maps with other key types and convert to/from strings.

class MapJsonAdapter<K, V> : JsonAdapter<Map<K, V>>

Constructors

MapJsonAdapter

open fun MapJsonAdapter(moshi: Moshi, keyType: Type, valueType: Type)

Functions

failOnUnknown

Returns a JSON adapter equal to this, but that throws a JsonDataException when unknown names and values are encountered. This constraint applies to both the top-level message handled by this type adapter as well as to nested messages.

@CheckReturnValue()

fun failOnUnknown(): JsonAdapter<T>

fromJson

@CheckReturnValue()

@Nullable()

abstract fun fromJson(reader: JsonReader): T

@CheckReturnValue()

@Nullable()

fun fromJson(string: String): T

@CheckReturnValue()

@Nullable()

fun fromJson(source: BufferedSource): T

open fun fromJson(reader: JsonReader): Map<K, V>

fromJsonValue

Decodes a Java value object from {@code value} , which must be comprised of maps, lists, strings, numbers, booleans and nulls.

@CheckReturnValue()

@Nullable()

fun fromJsonValue(value: Any): T

indent

Return a JSON adapter equal to this, but using {@code indent} to control how the result is formatted. The {@code indent} string to be repeated for each level of indentation in the encoded document. If {@code indent.isEmpty()} the encoded document will be compact. Otherwise the encoded document will be more human-readable.

@CheckReturnValue()

open fun indent(indent: String): JsonAdapter<T>

isLenient

open fun isLenient(): Boolean

lenient

Returns a JSON adapter equal to this, but is lenient when reading and writing.

@CheckReturnValue()

fun lenient(): JsonAdapter<T>

nonNull

Returns a JSON adapter equal to this JSON adapter, but that refuses null values. If null is read or written this will throw a JsonDataException .

Note that this adapter will not usually be invoked for absent values and so those must be handled elsewhere. This should only be used to fail on explicit nulls.

@CheckReturnValue()

fun nonNull(): JsonAdapter<T>

nullSafe

Returns a JSON adapter equal to this JSON adapter, but with support for reading and writing nulls.

@CheckReturnValue()

fun nullSafe(): JsonAdapter<T>

serializeNulls

Returns a JSON adapter equal to this JSON adapter, but that serializes nulls when encoding JSON.

@CheckReturnValue()

fun serializeNulls(): JsonAdapter<T>

toJson

@CheckReturnValue()

fun toJson(value: T): String

abstract fun toJson(writer: JsonWriter, value: T)

fun toJson(sink: BufferedSink, value: T)

open fun toJson(writer: JsonWriter, map: Map<K, V>)

toJsonValue

Encodes {@code value} as a Java value object comprised of maps, lists, strings, numbers, booleans, and nulls.

Values encoded using {@code value(double)} or {@code value(long)} are modeled with the corresponding boxed type. Values encoded using {@code value(Number)} are modeled as a for boxed integer types ( Byte , Short , Integer , and Long ), as a Double for boxed floating point types ( Float and Double ), and as a BigDecimal for all other types.

@CheckReturnValue()

@Nullable()

fun toJsonValue(value: T): Any

toString

open fun toString(): String

Properties

FACTORY

val FACTORY: JsonAdapter.Factory