Package com.squareup.moshi

Moshi is modern JSON library for Android and Java.

Types

FromJson

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

annotation class FromJson

Json

@Retention(value = RUNTIME)

annotation class Json

Customizes how a field is encoded as JSON.

JsonAdapter

abstract class JsonAdapter<T>

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

JsonClass

@Retention(value = RUNTIME)

annotation class JsonClass

Customizes how a type is encoded as JSON.

JsonDataException

class JsonDataException : RuntimeException

Thrown when the data in a JSON document doesn't match the data expected by the caller.

JsonEncodingException

class JsonEncodingException : IOException

Thrown when the data being parsed is not encoded as valid JSON.

JsonQualifier

@Target(value = ANNOTATION_TYPE)

@Retention(value = RUNTIME)

annotation class JsonQualifier

Annotates another annotation, causing it to specialize how values are encoded and decoded.

JsonReader

abstract class JsonReader : Closeable

Reads a JSON (RFC 7159) encoded value as a stream of tokens.

JsonWriter

abstract class JsonWriter : Closeable, Flushable

Writes a JSON (RFC 7159) encoded value to a stream, one token at a time.

Moshi

class Moshi

Coordinates binding between JSON values and Java objects.

ToJson

@Retention(value = RetentionPolicy.RUNTIME)

@Target(value = ElementType.METHOD)

annotation class ToJson

Types

@CheckReturnValue

class Types

Factory methods for types.

Functions

adapter

@ExperimentalStdlibApi

inline fun <T> Moshi.adapter(): JsonAdapter<T>

@ExperimentalStdlibApi

fun <T> Moshi.adapter(ktype: KType): JsonAdapter<T>

addAdapter

@ExperimentalStdlibApi

inline fun <T> Moshi.Builder.addAdapter(adapter: JsonAdapter<T>): Moshi.Builder

asArrayType

fun Type.asArrayType(): GenericArrayType

fun KClass<*>.asArrayType(): GenericArrayType

@ExperimentalStdlibApi

fun KType.asArrayType(): GenericArrayType

Returns a GenericArrayType with this as its GenericArrayType.getGenericComponentType.

nextAnnotations

inline fun <T : Annotation> Set<Annotation>.nextAnnotations(): Set<Annotation>?

Checks if this contains T. Returns the subset of this without T, or null if this does not contain T.

subtypeOf

@ExperimentalStdlibApi

inline fun <T> subtypeOf(): WildcardType

Returns a type that represents an unknown type that extends T. For example, if T is CharSequence, this returns out CharSequence. If T is Any, this returns *, which is shorthand for out Any?.

supertypeOf

@ExperimentalStdlibApi

inline fun <T> supertypeOf(): WildcardType

Returns a type that represents an unknown supertype of T bound. For example, if T is String, this returns in String.

Properties

rawType

val Type.rawType: Class<*>

Returns the raw Class type of this type.