パッケージ jakarta.json

インターフェース JsonWriter

すべてのスーパーインターフェース:
AutoCloseableSE, CloseableSE
public interface JsonWriter extends CloseableSE
JSON object または array 構造を出力ソースに書き込みます。

クラス Json には、出力ソース（OutputStreamSE および WriterSE）からライターを作成するためのメソッドが含まれています。

次の例は、空の JSON オブジェクトを書き込む方法を示しています。

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

クラス JsonWriterFactory には、JsonWriter インスタンスを作成するためのメソッドも含まれています。ファクトリインスタンスを使用して、同じ構成で複数のライターインスタンスを作成できます。これは、複数のインスタンスを作成するための推奨する方法です。次の例に使用例を示します。

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

  • 方法の概要

    修飾子と型
    メソッド
    説明
    void
    close()
    void
    write(JsonStructure value)
    指定された JSON object または array を出力ソースに書き込みます。
    default void
    write(JsonValue value)
    指定された JsonValue を出力ソースに書き込みます。
    void
    writeArray(JsonArray array)
    指定した JSON array を出力ソースに書き込みます。
    void
    writeObject(JsonObject object)
    指定した JSON object を出力ソースに書き込みます。

  • 方法の詳細

    • writeArray

      void writeArray(JsonArray array)
      指定された JSON array を出力ソースに書き込みます。このメソッドは、ライターインスタンスに対して 1 回だけ呼び出す必要があります。
      パラメーター:
      array - 出力ソースに書き込まれる JSON 配列
      例外:
      JsonException - I/O エラーのために指定された JSON オブジェクトを書き込めない場合 (IOException は JsonException の原因となる)
      IllegalStateExceptionSE - writeArray、writeObject、write、close メソッドがすでに呼び出されている場合

    • writeObject

      void writeObject(JsonObject object)
      指定された JSON object を出力ソースに書き込みます。このメソッドは、ライターインスタンスに対して 1 回だけ呼び出す必要があります。
      パラメーター:
      object - 出力ソースに書き込まれる JSON オブジェクト
      例外:
      JsonException - I/O エラーのために指定された JSON オブジェクトを書き込めない場合 (IOException は JsonException の原因となる)
      IllegalStateExceptionSE - writeArray、writeObject、write、close メソッドがすでに呼び出されている場合

    • write

      void write(JsonStructure value)
      指定された JSON object または array を出力ソースに書き込みます。このメソッドは、ライターインスタンスに対して 1 回だけ呼び出す必要があります。
      パラメーター:
      value - 出力ソースに書き込まれる JSON 配列またはオブジェクト
      例外:
      JsonException - I/O エラーのために指定された JSON オブジェクトを書き込めない場合 (IOException は JsonException の原因となる)
      IllegalStateExceptionSE - writeArray、writeObject、write、close メソッドがすでに呼び出されている場合

    • write

      default void write(JsonValue value)
      指定された JsonValue を出力ソースに書き込みます。メソッドは、書き込みインスタンスに対して 1 回だけ呼び出す必要があります。
      パラメーター:
      value - 出力ソースに書き込まれる JsonValue 
      例外:
      JsonException - I/O エラーのために指定された JSON オブジェクトを書き込めない場合 (IOException は JsonException の原因となる)
      IllegalStateExceptionSE - writeArray、writeObject、write、close メソッドがすでに呼び出されている場合
      導入:
      1.1

    • close

      void close()
      次で指定:
      インターフェース AutoCloseableSE 内の close 
      次で指定:
      インターフェース CloseableSE 内の close