-
- All Superinterfaces:
- AutoCloseable, Closeable
public interface JsonWriter extends Closeable
Writes a JSONobject
orarray
structure to an output source.The class
Json
contains methods to create writers from output sources (OutputStream
andWriter
).The following example demonstrates how write an empty JSON object:
JsonWriter jsonWriter = Json.createWriter(...); jsonWriter.writeObject(Json.createObjectBuilder().build()); jsonWriter.close();
The class
JsonWriterFactory
also contains methods to createJsonWriter
instances. A factory instance can be used to create multiple writer instances with the same configuration. This the preferred way to create multiple instances. A sample usage is shown in the following example:JsonWriterFactory factory = Json.createWriterFactory(config); JsonWriter writer1 = factory.createWriter(...); JsonWriter writer2 = factory.createWriter(...);
- Author:
- Jitendra Kotamraju
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
close()
Closes this JSON writer and frees any resources associated with the writer.void
write(JsonStructure value)
void
writeArray(JsonArray array)
Writes the specified JSONarray
to the output source.void
writeObject(JsonObject object)
Writes the specified JSONobject
to the output source.
-
-
-
Method Detail
-
writeArray
void writeArray(JsonArray array)
Writes the specified JSONarray
to the output source. This method needs to be called only once for a writer instance.- Parameters:
array
- JSON array that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
writeObject
void writeObject(JsonObject object)
Writes the specified JSONobject
to the output source. This method needs to be called only once for a writer instance.- Parameters:
object
- JSON object that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
write
void write(JsonStructure value)
Writes the specified JSONobject
orarray
to the output source. This method needs to be called only once for a writer instance.- Parameters:
value
- JSON array or object that is to be written to the output source- Throws:
JsonException
- if the specified JSON object cannot be written due to i/o error (IOException would be cause of JsonException)IllegalStateException
- if writeArray, writeObject, write or close method is already called
-
close
void close()
Closes this JSON writer and frees any resources associated with the writer. This method closes the underlying output 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/JsonWriter.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.