JsonAdapter

Converts Java values to JSON, and JSON values to Java.

JsonAdapter instances provided by Moshi are thread-safe, meaning multiple threads can safely use a single instance concurrently.

Custom JsonAdapter implementations should be designed to be thread-safe.

Types

Factory

interface Factory

Functions

failOnUnknown

@CheckReturnValue

fun failOnUnknown(): JsonAdapter<T>

Returns a JSON adapter equal to this, but that throws a JsonDataException when unknown names and values are encountered.

fromJson

@CheckReturnValue

@Nullable

abstract fun fromJson(reader: JsonReader): T

Decodes a nullable instance of type T from the given reader.

@CheckReturnValue

@Nullable

fun fromJson(string: String): T

Decodes a nullable instance of type T from the given string.

@CheckReturnValue

@Nullable

fun fromJson(source: BufferedSource): T

Decodes a nullable instance of type T from the given source.

fromJsonValue

@CheckReturnValue

@Nullable

fun fromJsonValue(@Nullable value: Any): T

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

indent

@CheckReturnValue

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

Return a JSON adapter equal to this, but using indent to control how the result is formatted.

lenient

@CheckReturnValue

fun lenient(): JsonAdapter<T>

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

nonNull

@CheckReturnValue

fun nonNull(): JsonAdapter<T>

Returns a JSON adapter equal to this JSON adapter, but that refuses null values.

nullSafe

@CheckReturnValue

fun nullSafe(): JsonAdapter<T>

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

serializeNulls

@CheckReturnValue

fun serializeNulls(): JsonAdapter<T>

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

toJson

@CheckReturnValue

fun toJson(@Nullable value: T): String

Encodes the given value into a String and returns it.

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

Encodes the given value with the given writer.

fun toJson(sink: BufferedSink, @Nullable value: T)

toJsonValue

@CheckReturnValue

@Nullable

fun toJsonValue(@Nullable value: T): Any

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

Inheritors

NullSafeJsonAdapter

NonNullJsonAdapter