moshi/com.squareup.moshi/ClassJsonAdapter

ClassJsonAdapter

Emits a regular class as a JSON object by mapping Java fields to JSON object properties.

Platform Types Fields from platform classes are omitted from both serialization and deserialization unless they are either public or protected. This includes the following packages and their subpackages:

android.*
androidx.*
java.*
javax.*
kotlin.*
kotlinx.*
scala.*

class ClassJsonAdapter<T> : JsonAdapter<T>

Constructors

ClassJsonAdapter

open fun ClassJsonAdapter(classFactory: ClassFactory<T>, fieldsMap: Map<String, ClassJsonAdapter.FieldBinding<out Any>>)

Types

FieldBinding

open class FieldBinding<T>

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

open fun fromJson(reader: JsonReader): T

@CheckReturnValue()

@Nullable()

fun fromJson(string: String): T

@CheckReturnValue()

@Nullable()

fun fromJson(source: BufferedSource): T

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

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

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

fun toJson(sink: BufferedSink, value: T)

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