JsonReader
class JsonReader : Closeable
kotlin.Any | |
↳ | android.util.JsonReader |
Reads a JSON (RFC 4627) encoded value as a stream of tokens. This stream includes both literal values (strings, numbers, booleans, and nulls) as well as the begin and end delimiters of objects and arrays. The tokens are traversed in depth-first order, the same order that they appear in the JSON document. Within JSON objects, name/value pairs are represented by a single token.
Parsing JSON
To create a recursive descent parser for your own JSON streams, first create an entry point method that creates aJsonReader
.
Next, create handler methods for each structure in your JSON text. You'll need a method for each object type and for each array type.
- Within array handling methods, first call
beginArray
to consume the array's opening bracket. Then create a while loop that accumulates values, terminating whenhasNext
is false. Finally, read the array's closing bracket by callingendArray
. - Within object handling methods, first call
beginObject
to consume the object's opening brace. Then create a while loop that assigns values to local variables based on their name. This loop should terminate whenhasNext
is false. Finally, read the object's closing brace by callingendObject
.
When a nested object or array is encountered, delegate to the corresponding handler method.
When an unknown name is encountered, strict parsers should fail with an exception. Lenient parsers should call skipValue()
to recursively skip the value's nested tokens, which may otherwise conflict.
If a value may be null, you should first check using peek()
. Null literals can be consumed using either nextNull()
or skipValue()
.
Example
Suppose we'd like to parse a stream of messages such as the following:<code>[ { "id": 912345678901, "text": "How do I read JSON on Android?", "geo": null, "user": { "name": "android_newb", "followers_count": 41 } }, { "id": 912345678902, "text": "@android_newb just use android.util.JsonReader!", "geo": [50.454722, -104.606667], "user": { "name": "jesse", "followers_count": 2 } } ]</code>This code implements the parser for the above structure:
<code>public List<Message> readJsonStream(InputStream in) throws IOException { JsonReader reader = new JsonReader(new InputStreamReader(in, "UTF-8")); try { return readMessagesArray(reader); } finally { reader.close(); } } public List<Message> readMessagesArray(JsonReader reader) throws IOException { List<Message> messages = new ArrayList<Message>(); reader.beginArray(); while (reader.hasNext()) { messages.add(readMessage(reader)); } reader.endArray(); return messages; } public Message readMessage(JsonReader reader) throws IOException { long id = -1; String text = null; User user = null; List<Double> geo = null; reader.beginObject(); while (reader.hasNext()) { String name = reader.nextName(); if (name.equals("id")) { id = reader.nextLong(); } else if (name.equals("text")) { text = reader.nextString(); } else if (name.equals("geo") && reader.peek() != JsonToken.NULL) { geo = readDoublesArray(reader); } else if (name.equals("user")) { user = readUser(reader); } else { reader.skipValue(); } } reader.endObject(); return new Message(id, text, user, geo); } public List<Double> readDoublesArray(JsonReader reader) throws IOException { List<Double> doubles = new ArrayList<Double>(); reader.beginArray(); while (reader.hasNext()) { doubles.add(reader.nextDouble()); } reader.endArray(); return doubles; } public User readUser(JsonReader reader) throws IOException { String username = null; int followersCount = -1; reader.beginObject(); while (reader.hasNext()) { String name = reader.nextName(); if (name.equals("name")) { username = reader.nextString(); } else if (name.equals("followers_count")) { followersCount = reader.nextInt(); } else { reader.skipValue(); } } reader.endObject(); return new User(username, followersCount); }</code>
Number Handling
This reader permits numeric values to be read as strings and string values to be read as numbers. For example, both elements of the JSON array[1, "1"]
may be read using either nextInt
or nextString
. This behavior is intended to prevent lossy numeric conversions: double is JavaScript's only numeric type and very large values like 9007199254740993
cannot be represented exactly on that platform. To minimize precision loss, extremely large values should be written and read as strings in JSON.
Each JsonReader
may be used to read a single JSON stream. Instances of this class are not thread safe.
Summary
Public constructors | |
---|---|
JsonReader(in: Reader!) Creates a new instance that reads a JSON-encoded stream from |
Public methods | |
---|---|
Unit |
Consumes the next token from the JSON stream and asserts that it is the beginning of a new array. |
Unit |
Consumes the next token from the JSON stream and asserts that it is the beginning of a new object. |
Unit |
close() Closes this JSON reader and the underlying |
Unit |
endArray() Consumes the next token from the JSON stream and asserts that it is the end of the current array. |
Unit |
Consumes the next token from the JSON stream and asserts that it is the end of the current object. |
Boolean |
hasNext() Returns true if the current array or object has another element. |
Boolean |
Returns true if this parser is liberal in what it accepts. |
Boolean |
Returns the |
Double |
Returns the |
Int |
nextInt() Returns the |
Long |
nextLong() Returns the |
String! |
nextName() Returns the next token, a |
Unit |
nextNull() Consumes the next token from the JSON stream and asserts that it is a literal null. |
String! |
Returns the |
JsonToken! |
peek() Returns the type of the next token without consuming it. |
Unit |
setLenient(lenient: Boolean) Configure this parser to be be liberal in what it accepts. |
Unit |
Skips the next value recursively. |
String |
toString() |
Public constructors
JsonReader
JsonReader(in: Reader!)
Creates a new instance that reads a JSON-encoded stream from in
.
Public methods
beginArray
fun beginArray(): Unit
Consumes the next token from the JSON stream and asserts that it is the beginning of a new array.
beginObject
fun beginObject(): Unit
Consumes the next token from the JSON stream and asserts that it is the beginning of a new object.
close
fun close(): Unit
Closes this JSON reader and the underlying Reader
.
Exceptions | |
---|---|
java.lang.Exception |
if this resource cannot be closed |
java.io.IOException |
if an I/O error occurs |
endArray
fun endArray(): Unit
Consumes the next token from the JSON stream and asserts that it is the end of the current array.
endObject
fun endObject(): Unit
Consumes the next token from the JSON stream and asserts that it is the end of the current object.
hasNext
fun hasNext(): Boolean
Returns true if the current array or object has another element.
isLenient
fun isLenient(): Boolean
Returns true if this parser is liberal in what it accepts.
nextBoolean
fun nextBoolean(): Boolean
Returns the boolean
value of the next token, consuming it.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not a boolean or if this reader is closed. |
nextDouble
fun nextDouble(): Double
Returns the double
value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a double using Double#parseDouble(String)
.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not a literal value. |
nextInt
fun nextInt(): Int
Returns the int
value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as an int. If the next token's numeric value cannot be exactly represented by a Java int
, this method throws.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not a literal value. |
java.lang.NumberFormatException |
if the next literal value cannot be parsed as a number, or exactly represented as an int. |
nextLong
fun nextLong(): Long
Returns the long
value of the next token, consuming it. If the next token is a string, this method will attempt to parse it as a long. If the next token's numeric value cannot be exactly represented by a Java long
, this method throws.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not a literal value. |
java.lang.NumberFormatException |
if the next literal value cannot be parsed as a number, or exactly represented as a long. |
nextName
fun nextName(): String!
Returns the next token, a property name
, and consumes it.
Exceptions | |
---|---|
java.io.IOException |
if the next token in the stream is not a property name. |
nextNull
fun nextNull(): Unit
Consumes the next token from the JSON stream and asserts that it is a literal null.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not null or if this reader is closed. |
nextString
fun nextString(): String!
Returns the string
value of the next token, consuming it. If the next token is a number, this method will return its string form.
Exceptions | |
---|---|
java.lang.IllegalStateException |
if the next token is not a string or if this reader is closed. |
peek
fun peek(): JsonToken!
Returns the type of the next token without consuming it.
setLenient
fun setLenient(lenient: Boolean): Unit
Configure this parser to be be liberal in what it accepts. By default, this parser is strict and only accepts JSON as specified by RFC 4627. Setting the parser to lenient causes it to ignore the following syntax errors:
- End of line comments starting with
//
orand ending with a newline character.
- C-style comments starting with
/*
and ending with*
/
. Such comments may not be nested. - Names that are unquoted or
'single quoted'
. - Strings that are unquoted or
'single quoted'
. - Array elements separated by
;
instead of,
. - Unnecessary array separators. These are interpreted as if null was the omitted value.
- Names and values separated by
=
or=>
instead of:
. - Name/value pairs separated by
;
instead of,
.
skipValue
fun skipValue(): Unit
Skips the next value recursively. If it is an object or array, all nested elements are skipped. This method is intended for use when the JSON token stream contains unrecognized or unhandled values.
toString
fun toString(): String
Return | |
---|---|
String |
a string representation of the object. |