public interface JsonReader extends Closeable
object
or an array
structure from an input source.
The class Json
contains methods to create readers from
input sources (InputStream
and Reader
).
The following example demonstrates how to read an empty JSON array from a string:
JsonReader jsonReader = Json.createReader(new StringReader("[]"));
JsonArray array = jsonReader.readArray();
jsonReader.close();
The class JsonReaderFactory
also contains methods to create
JsonReader
instances. A factory instance can be used to create
multiple reader instances with the same configuration. This the preferred
way to create multiple instances. A sample usage is shown in the following
example:
JsonReaderFactory factory = Json.createReaderFactory(config);
JsonReader reader1 = factory.createReader(...);
JsonReader reader2 = factory.createReader(...);
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes this reader and frees any resources associated with the
reader.
|
JsonStructure |
read()
Returns a JSON array or object that is represented in
the input source.
|
JsonArray |
readArray()
Returns a JSON array that is represented in
the input source.
|
JsonObject |
readObject()
Returns a JSON object that is represented in
the input source.
|
default JsonValue |
readValue()
Returns a JSON value that is represented in
the input source.
|
JsonStructure read()
JsonException
- if a JSON object or array cannot
be created due to i/o error (IOException would be
cause of JsonException)JsonParsingException
- if a JSON object or array
cannot be created due to incorrect representationIllegalStateException
- if read, readObject, readArray,
readValue or close method is already calledJsonObject readObject()
JsonException
- if a JSON object cannot
be created due to i/o error (IOException would be
cause of JsonException)JsonParsingException
- if a JSON object cannot
be created due to incorrect representationIllegalStateException
- if read, readObject, readArray,
readValue or close method is already calledJsonArray readArray()
JsonException
- if a JSON array cannot
be created due to i/o error (IOException would be
cause of JsonException)JsonParsingException
- if a JSON array cannot
be created due to incorrect representationIllegalStateException
- if read, readObject, readArray,
readValue or close method is already calleddefault JsonValue readValue()
JsonException
- if a JSON value
be created due to i/o error (IOException would be
cause of JsonException)JsonParsingException
- if a JSON value
cannot be created due to incorrect representationIllegalStateException
- if read, readObject, readArray,
readValue or close method is already calledvoid close()
close
in interface AutoCloseable
close
in interface Closeable
JsonException
- if an i/o error occurs (IOException would be
cause of JsonException)Copyright © 2021 JBoss by Red Hat. All rights reserved.