Package javax.json
Interface JsonWriter
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.io.Closeable
public interface JsonWriter extends java.io.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(...);
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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)java.lang.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)java.lang.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)java.lang.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 interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Throws:
JsonException
- if an i/o error occurs (IOException would be cause of JsonException)
-
-