-
- All Superinterfaces:
- AutoCloseable, Closeable
public interface JsonReader extends Closeable
Reads a JSONobject
or anarray
structure from an input source.The class
Json
contains methods to create readers from input sources (InputStream
andReader
).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 createJsonReader
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(...);
- Author:
- Jitendra Kotamraju
-
-
Method Summary
All Methods Instance Methods Abstract Methods 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.
-
-
-
Method Detail
-
read
JsonStructure read()
Returns a JSON array or object that is represented in the input source. This method needs to be called only once for a reader instance.- Returns:
- a JSON object or array
- Throws:
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 or close method is already called
-
readObject
JsonObject readObject()
Returns a JSON object that is represented in the input source. This method needs to be called only once for a reader instance.- Returns:
- a JSON object
- Throws:
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 or close method is already called
-
readArray
JsonArray readArray()
Returns a JSON array that is represented in the input source. This method needs to be called only once for a reader instance.- Returns:
- a JSON array
- Throws:
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 or close method is already called
-
close
void close()
Closes this reader and frees any resources associated with the reader. This method closes the underlying input source.- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Throws:
JsonException
- if an i/o error occurs (IOException would be cause of JsonException)
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/json/jsonreader.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.