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
を名前または値として使用することはできません
JsonArrayBuilder
修飾子と型 | メソッドと説明 |
---|---|
JsonObjectBuilder | add(StringSE name, BigDecimalSE value) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。 |
JsonObjectBuilder | add(StringSE name, BigIntegerSE value) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。 |
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, JsonArrayBuilder builder) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonArray のペアを追加します。 |
JsonObjectBuilder | add(StringSE name, JsonObjectBuilder builder) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonObject のペアを追加します。 |
JsonObjectBuilder | add(StringSE name, JsonValue value) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonValue のペアを追加します。 |
JsonObjectBuilder | add(StringSE name, long value) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonNumber のペアを追加します。 |
JsonObjectBuilder | add(StringSE name, StringSE value) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonString のペアを追加します。 |
default JsonObjectBuilder | addAll(JsonObjectBuilder builder) 指定されたオブジェクトビルダーに関連付けられた JSON オブジェクトのすべての名前 / 値ペアを、このオブジェクトビルダーに関連付けられた JSON オブジェクトに追加します。 |
JsonObjectBuilder | addNull(StringSE name) このオブジェクトビルダーに関連付けられた JSON オブジェクトに名前と JsonValue#NULL のペアを追加します。値は null です。 |
JsonObject | build() このオブジェクトビルダーに関連付けられた JSON オブジェクトを返します。 |
default JsonObjectBuilder | remove(StringSE name) このオブジェクトビルダーに関連付けられている JSON オブジェクトが存在する場合は、名前と値のペアを削除します。 |
JsonObjectBuilder add(StringSE name, JsonValue value)
JsonValue
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前または値が null の場合 JsonObjectBuilder add(StringSE name, StringSE value)
JsonString
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前または値が null の場合 JsonObjectBuilder add(StringSE name, BigIntegerSE value)
JsonNumber
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前または値が null の場合 JsonNumber
JsonObjectBuilder add(StringSE name, BigDecimalSE value)
JsonNumber
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前または値が null の場合 JsonNumber
JsonObjectBuilder add(StringSE name, int value)
JsonNumber
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前が null の場合 JsonNumber
JsonObjectBuilder add(StringSE name, long value)
JsonNumber
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前が null の場合 JsonNumber
JsonObjectBuilder add(StringSE name, double value)
JsonNumber
のペアを追加します。オブジェクトに指定した名前のマッピングが含まれている場合、このメソッドは古い値を指定した値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NumberFormatExceptionSE
- 値が非数(NaN)または無限大の場合 NullPointerExceptionSE
- 指定された名前が null の場合 JsonNumber
JsonObjectBuilder add(StringSE name, boolean value)
JsonValue#TRUE
または名前 /JsonValue#FALSE
ペアを追加します。オブジェクトに指定された名前のマッピングが含まれている場合、このメソッドは古い値を指定された値に置き換えます。name
- 名前 / 値ペアの名前 value
- 名前 / 値ペアの値 NullPointerExceptionSE
- 指定された名前が null の場合 JsonObjectBuilder addNull(StringSE name)
JsonValue#NULL
のペアを追加します。値は null
です。指定した名前のマッピングがオブジェクトに含まれている場合、このメソッドは古い値を null
に置き換えます。name
- 名前 / 値ペアの名前 NullPointerExceptionSE
- 指定された名前が null の場合 JsonObjectBuilder add(StringSE name, JsonObjectBuilder builder)
JsonObject
のペアを追加します。値 JsonObject
は、指定されたオブジェクトビルダーから構築されます。指定された名前のマッピングがオブジェクトに含まれている場合、このメソッドは古い値を指定されたオブジェクトビルダーの JsonObject
で置き換えます。name
- 名前 / 値ペアの名前 builder
- 値はこのビルダーに関連付けられたオブジェクトです NullPointerExceptionSE
- 指定された名前またはビルダーが null の場合 JsonObjectBuilder add(StringSE name, JsonArrayBuilder builder)
JsonArray
のペアを追加します。値 JsonArray
は、指定された配列ビルダーから構築されます。オブジェクトに指定された名前のマッピングが含まれている場合、このメソッドは古い値を指定された配列ビルダーの JsonArray
で置き換えます。name
- 名前と値のペアの名前 builder
- 値はこのビルダーのオブジェクト配列です NullPointerExceptionSE
- 指定された名前またはビルダーが null の場合 default JsonObjectBuilder addAll(JsonObjectBuilder builder)
builder
- 指定されたオブジェクトビルダー NullPointerExceptionSE
- 指定されたビルダーが null の場合 default JsonObjectBuilder remove(StringSE name)
name
- 削除する名前と値のペアの名前 NullPointerExceptionSE
- 指定された名前が null の場合 JsonObject build()
JsonObject
の反復順序は、名前と値のペアがこのビルダーを使用してオブジェクトに追加される順序に基づいています。Copyright © 2019 Eclipse Foundation.
Use is subject to license terms.