com.squareup.moshi

Class JsonAdapter<T>

java.lang.Object

com.squareup.moshi.JsonAdapter<T>

public abstract class JsonAdapter<T>
extends Object

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JsonAdapter.Factory

Constructor Summary

Constructors

Constructor and Description
JsonAdapter()

Method Summary

Modifier and Type	Method and Description
JsonAdapter<T>	failOnUnknown() Returns a JSON adapter equal to this, but that throws a JsonDataException when unknown names and values are encountered.
T	fromJson(okio.BufferedSource source)
abstract T	fromJson(JsonReader reader)
T	fromJson(String string)
T	fromJsonValue(Object value) Decodes a Java value object from value, which must be comprised of maps, lists, strings, numbers, booleans and nulls.
JsonAdapter<T>	indent(String indent) Return a JSON adapter equal to this, but using indent to control how the result is formatted.
JsonAdapter<T>	lenient() Returns a JSON adapter equal to this, but is lenient when reading and writing.
JsonAdapter<T>	nonNull() Returns a JSON adapter equal to this JSON adapter, but that refuses null values.
JsonAdapter<T>	nullSafe() Returns a JSON adapter equal to this JSON adapter, but with support for reading and writing nulls.
JsonAdapter<T>	serializeNulls() Returns a JSON adapter equal to this JSON adapter, but that serializes nulls when encoding JSON.
void	toJson(okio.BufferedSink sink, T value)
abstract void	toJson(JsonWriter writer, T value)
String	toJson(T value)
Object	toJsonValue(T value) Encodes value as a Java value object comprised of maps, lists, strings, numbers, booleans, and nulls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonAdapter

public JsonAdapter()

Method Detail

fromJson

@CheckReturnValue
 @Nullable
public abstract T fromJson(JsonReader reader)
                                                 throws IOException

Throws:

IOException

fromJson

@CheckReturnValue
 @Nullable
public final T fromJson(okio.BufferedSource source)
                                              throws IOException

Throws:

IOException

fromJson

@CheckReturnValue
 @Nullable
public final T fromJson(String string)
                                              throws IOException

Throws:

IOException

toJson

public abstract void toJson(JsonWriter writer,
                            @Nullable
                            T value)
                     throws IOException

Throws:

IOException

toJson

public final void toJson(okio.BufferedSink sink,
                         @Nullable
                         T value)
                  throws IOException

Throws:

IOException

toJson

@CheckReturnValue
public final String toJson(@Nullable
                                             T value)

toJsonValue

@CheckReturnValue
 @Nullable
public final Object toJsonValue(@Nullable
                                                             T value)

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

Values encoded using value(double) or value(long) are modeled with the corresponding boxed type. Values encoded using value(Number) are modeled as a Long 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.

fromJsonValue

@CheckReturnValue
 @Nullable
public final T fromJsonValue(@Nullable
                                                          Object value)

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

serializeNulls

@CheckReturnValue
public final JsonAdapter<T> serializeNulls()

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

nullSafe

@CheckReturnValue
public final JsonAdapter<T> nullSafe()

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

nonNull

@CheckReturnValue
public final 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.

lenient

@CheckReturnValue
public final JsonAdapter<T> lenient()

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

failOnUnknown

@CheckReturnValue
public final JsonAdapter<T> 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.

indent

@CheckReturnValue
public JsonAdapter<T> indent(String indent)

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

Parameters:

indent - a string containing only whitespace.