Package javax.json

Interface JsonWriter

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable
    public interface JsonWriter
extends java.io.Closeable
    Writes a JSON object or array structure to an output source.

    This is a near-exact copy of the same-titled Java EE 8 Class: javax.json.JsonWriter
    Commenting has been slightly modified to accompany HiLiting the Code Examples.
    Java Source Code remains identical to the Sun-Oracle & 'GlassFish' Released Distributions.

    Read included License: HERE, and the CDDL+GPL-1.1
    All javax.json.* Code Obtained From: GitHub JavaEE jsonp  Public Archive.

    The class Json contains methods to create writers from output sources (OutputStream and Writer).

    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 create JsonWriter 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 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)
        java.lang.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)
        java.lang.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)
        java.lang.IllegalStateException - if writeArray, writeObject, write or close method is already called

      • write

        🡅  🡇  ⇈  ⮫ 🗕  🗗  🗖 
        default void write​(JsonValue value)
        Writes the specified JsonValue to the output source. method needs to be called only once for a write instance.
        Parameters:
        value - a JsonValue 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
        Since:
        1.1
        Code:
        Exact Method Body:
         throw new UnsupportedOperationException();

      • close

        🡅  ⇈  ⮫ 🗕  🗗  🗖 
        void close()
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable