apollo-api/com.apollographql.apollo3.api.json/MapJsonReader

MapJsonReader

class MapJsonReader @JvmOverloads constructor(val root: Map<String, Any?>, pathRoot: List<Any> = emptyList()) : JsonReader

A JsonReader that reads data from a regular Map

Map values should be any of:

String
Int
Double
Long
JsonNumber
null
Map where values are any of these values recursively
List where values are any of these values recursively

Anything else is undefined

To read from a okio.BufferedSource, see also BufferedSourceJsonReader

Parameters

root

the root Map to read from

pathRoot

the path root to be prefixed to the returned path when calling getPath. Useful for buffer.

Constructors

fun MapJsonReader(root: Map<String, Any?>, pathRoot: List<Any> = emptyList())

Types

object Companion

Functions

open override fun beginArray(): MapJsonReader

Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.

open override fun beginObject(): MapJsonReader

Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.

open override fun close()

open override fun endArray(): MapJsonReader

Consumes the next token from the JSON stream and asserts that it is the end of the current array.

open override fun endObject(): MapJsonReader

Consumes the next token from the JSON stream and asserts that it is the end of the current object.

open override fun getPath(): List<Any>

Returns the current path of the JSON being read, as a List. The elements can either be Strings (names) or Integers (array indices).

open override fun hasNext(): Boolean

Returns true if the current array or object has another element.

open override fun nextBoolean(): Boolean

Returns the Token.BOOLEAN value of the next token, consuming it.

open override fun nextDouble(): Double

Returns the Token.NUMBER value of the next token, consuming it.

open override fun nextInt(): Int

Returns the Token.NUMBER value of the next token, consuming it.

open override fun nextLong(): Long

Returns the Token.NUMBER value of the next token, consuming it.

open override fun nextName(): String

Returns the next token Token.NAME, and consumes it.

open override fun nextNull(): Nothing?

Consumes the next token from the JSON stream and asserts that it is a literal null. Returns null.

open override fun nextNumber(): JsonNumber

Returns the Token.NUMBER value of the next token, consuming it.

open override fun nextString(): String?

Returns the Token.STRING value of the next token, consuming it.

fun nextValue(): Any

open override fun peek(): JsonReader.Token

Returns the type of the next token without consuming it.

open override fun rewind()

Rewinds to the beginning of the current object.

open override fun selectName(names: List<String>): Int

An optimized way to retrieve the nextName when the candidates and their order is known. selectName maintains the current index in the list and saves having to string compare nextName to every candidate.

open override fun skipValue()

Skips the next value recursively. If it is an object or array, all nested elements are skipped.

Properties

val root: Map<String, Any?>