All Superinterfaces:

AutoCloseable, Closeable

public interface JsonWriter
extends Closeable 

 
 JsonWriter jsonWriter = Json.createWriter(...);
 jsonWriter.writeObject(Json.createObjectBuilder().build());
 jsonWriter.close();
 
 

 
 JsonWriterFactory factory = Json.createWriterFactory(config);
 JsonWriter writer1 = factory.createWriter(...);
 JsonWriter writer2 = factory.createWriter(...);
 
 

Author:

Jitendra Kotamraju

• Method Summary

  All 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) Writes the specified JSON object or array to the output source.
  void	writeArray (JsonArray array) Writes the specified JSON array to the output source.
  void	writeObject (JsonObject object) Writes the specified JSON object to the output source.

• Method Detail

  • writeArray

    void writeArray(JsonArray array)

    Writes the specified JSON array 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 JSON object 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 JSON object or array 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 interface AutoCloseable

    Specified by:

    close in interface Closeable

    Throws:

    JsonException - if an i/o error occurs (IOException would be cause of JsonException)