パッケージ jakarta.json

インターフェース JsonObjectBuilder

public interface JsonObjectBuilder
ゼロから JsonObject モデルを作成するためのビルダー。このインターフェースは、空の JSON オブジェクトモデルを初期化し、オブジェクトモデルに名前と値のペアを追加し、結果のオブジェクトを返すメソッドを提供します。このクラスのメソッドをチェーンして、複数の名前と値のペアをオブジェクトに追加できます。

クラス Json には、ビルダーオブジェクトを作成するためのメソッドが含まれています。以下のコード例は、空の JsonObject インスタンスを作成する方法を示しています。

 
 JsonObject object = Json.createObjectBuilder().build();

クラス JsonBuilderFactory には、JsonObjectBuilder インスタンスを作成するためのメソッドも含まれています。ファクトリインスタンスを使用して、同じ構成で複数のビルダーインスタンスを作成できます。これは、複数のインスタンスを作成するための推奨する方法です。以下のコード例は、次の JSON オブジェクトを表す JsonObject モデルを構築する方法を示しています。

 
 {
     "firstName": "John", "lastName": "Smith", "age": 25,
     "address" : {
         "streetAddress": "21 2nd Street",
         "city": "New York",
         "state": "NY",
         "postalCode": "10021"
     },
     "phoneNumber": [
         { "type": "home", "number": "212 555-1234" },
         { "type": "fax", "number": "646 555-4567" }
     ]
 }

上記のオブジェクトを作成するコードは次のとおりです。

 
 JsonBuilderFactory factory = Json.createBuilderFactory(config);
 JsonObject value = factory.createObjectBuilder()
     .add("firstName", "John")
     .add("lastName", "Smith")
     .add("age", 25)
     .add("address", factory.createObjectBuilder()
         .add("streetAddress", "21 2nd Street")
         .add("city", "New York")
         .add("state", "NY")
         .add("postalCode", "10021"))
     .add("phoneNumber", factory.createArrayBuilder()
         .add(factory.createObjectBuilder()
             .add("type", "home")
             .add("number", "212 555-1234"))
         .add(factory.createObjectBuilder()
             .add("type", "fax")
             .add("number", "646 555-4567")))
     .build();

このクラスでは、JSON オブジェクトの作成中に null を名前または値として使用することはできません

関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    JsonObjectBuilder
    add(StringSE name, boolean value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前 /JsonValue#TRUE または名前 /JsonValue#FALSE ペアを追加します。
    JsonObjectBuilder
    add(StringSE name, double value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, int value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, long value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, JsonArrayBuilder builder)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonArray のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, JsonObjectBuilder builder)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonObject のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, JsonValue value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonValue のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, StringSE value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonString のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, BigDecimalSE value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。
    JsonObjectBuilder
    add(StringSE name, BigIntegerSE value)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。
    default JsonObjectBuilder
    addAll(JsonObjectBuilder builder)
    指定されたオブジェクトビルダーに関連付けられた JSON オブジェクトのすべての名前 / 値ペアを、このオブジェクトビルダーに関連付けられた JSON オブジェクトに追加します。
    JsonObjectBuilder
    addNull(StringSE name)
    このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonValue#NULL のペアを追加します。値は null です。
    JsonObject
    build()
    このオブジェクトビルダーに関連付けられた JSON オブジェクトを返します。
    default JsonObjectBuilder
    remove(StringSE name)
    このオブジェクトビルダーに関連付けられている JSON オブジェクトが存在する場合は、名前と値のペアを削除します。

  • メソッドの詳細

    • add

      JsonObjectBuilder add(StringSE name, JsonValue value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonValue のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前または値が null の場合

    • add

      JsonObjectBuilder add(StringSE name, StringSE value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonString のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前または値が null の場合

    • add

      JsonObjectBuilder add(StringSE name, BigIntegerSE value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前または値が null の場合
      関連事項:

    • add

      JsonObjectBuilder add(StringSE name, BigDecimalSE value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前または値が null の場合
      関連事項:

    • add

      JsonObjectBuilder add(StringSE name, int value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前が null の場合
      関連事項:

    • add

      JsonObjectBuilder add(StringSE name, long value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前が null の場合
      関連事項:

    • add

      JsonObjectBuilder add(StringSE name, double value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NumberFormatExceptionSE - 値が非数（NaN）または無限大の場合
      NullPointerExceptionSE - 指定された名前が null の場合
      関連事項:

    • add

      JsonObjectBuilder add(StringSE name, boolean value)
      このオブジェクトビルダーに関連付けられた JSON オブジェクトに、名前 /JsonValue#TRUE または名前 /JsonValue#FALSE ペアを追加します。オブジェクトに指定された名前のマッピングが含まれている場合、このメソッドは古い値を指定された値に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      value - 名前 / 値ペアの値
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前が null の場合

    • addNull

      JsonObjectBuilder addNull(StringSE name)
      このオブジェクトビルダーに関連付けられている JSON オブジェクトに名前と JsonValue#NULL のペアを追加します。値は null です。指定した名前のマッピングがオブジェクトに含まれている場合、このメソッドは古い値を null に置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前が null の場合

    • add

      JsonObjectBuilder add(StringSE name, JsonObjectBuilder builder)
      このオブジェクトビルダーに関連付けられている JSON オブジェクトに名前と JsonObject のペアを追加します。値 JsonObject は、指定されたオブジェクトビルダーから構築されます。指定された名前のマッピングがオブジェクトに含まれている場合、このメソッドは古い値を指定されたオブジェクトビルダーの JsonObject で置き換えます。
      パラメーター:
      name - 名前 / 値ペアの名前
      builder - 値はこのビルダーに関連付けられたオブジェクトです
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前またはビルダーが null の場合

    • add

      JsonObjectBuilder add(StringSE name, JsonArrayBuilder builder)
      このオブジェクトビルダーに関連付けられている JSON オブジェクトに名前と JsonArray のペアを追加します。値 JsonArray は、指定された配列ビルダーから構築されます。オブジェクトに指定された名前のマッピングが含まれている場合、このメソッドは古い値を指定された配列ビルダーの JsonArray で置き換えます。
      パラメーター:
      name - 名前と値のペアの名前
      builder - 値はこのビルダーのオブジェクト配列です
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前またはビルダーが null の場合

    • addAll

      default JsonObjectBuilder addAll(JsonObjectBuilder builder)
      指定されたオブジェクトビルダーに関連付けられた JSON オブジェクトのすべての名前と値のペアを、このオブジェクトビルダーに関連付けられた JSON オブジェクトに追加します。新しく追加された名前 / 値ペアは、既存の名前 / 値ペアを同じ名前で置き換えます。
      パラメーター:
      builder - 指定されたオブジェクトビルダー
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定されたビルダーが null の場合
      導入:
      1.1

    • remove

      default JsonObjectBuilder remove(StringSE name)
      このオブジェクトビルダーに関連付けられている JSON オブジェクトが存在する場合は、名前と値のペアを削除します。
      パラメーター:
      name - 削除する名前と値のペアの名前
      戻り値:
      このオブジェクトビルダー
      例外:
      NullPointerExceptionSE - 指定された名前が null の場合
      導入:
      1.1

    • build

      JsonObject build()
      このオブジェクトビルダーに関連付けられた JSON オブジェクトを返します。JsonObject の反復順序は、この Builder を使用して名前と値のペアがオブジェクトに追加される順序に基づいています。このメソッドはビルダーをクリアします。
      戻り値:
      構築中の JSON オブジェクト