パッケージ jakarta.json
インターフェース JsonArrayBuilder
public interface JsonArrayBuilder
ゼロからJsonArray
モデルを作成し、既存のJsonArray
を変更するためのビルダー。JsonArrayBuilder
は、空または空でない JSON 配列モデルで開始できます。このインターフェースは、JSON 配列モデルの値を追加、挿入、削除、置換するメソッドを提供します。このクラスのメソッドをチェーンして、配列に対して複数の値を実行できます。
クラス
Json
には、ビルダーオブジェクトを作成するためのメソッドが含まれています。以下のコード例は、空のJsonArray
インスタンスを作成する方法を示しています。JsonArray array = Json.createArrayBuilder().build();
クラス
JsonBuilderFactory
には、JsonArrayBuilder
インスタンスを作成するためのメソッドも含まれています。ファクトリインスタンスを使用して、同じ構成で複数のビルダーインスタンスを作成できます。これは、複数のインスタンスを作成するための推奨される方法です。以下のコード例は、次の JSON 配列を表すJsonArray
オブジェクトを構築する方法を示しています。[ { "type": "home", "number": "212 555-1234" }, { "type": "fax", "number": "646 555-4567" } ]
次のコードは、上記の JSON 配列を作成します。
JsonBuilderFactory factory = Json.createBuilderFactory(config); JsonArray value = 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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド デフォルトメソッド 修飾子と型 メソッド 説明 JsonArrayBuilder
add(boolean value)
JsonValue.TRUE
またはJsonValue.FALSE
値を配列に追加します。JsonArrayBuilder
add(double value)
値をJsonNumber
として配列に追加します。JsonArrayBuilder
add(int value)
値をJsonNumber
として配列に追加します。default JsonArrayBuilder
add(int index, boolean value)
JsonValue.TRUE
またはJsonValue.FALSE
値を配列の指定された位置に追加します。default JsonArrayBuilder
add(int index, double value)
指定された位置にJsonNumber
として値を配列に追加します。default JsonArrayBuilder
add(int index, int value)
指定された位置にJsonNumber
として値を配列に追加します。default JsonArrayBuilder
add(int index, long value)
指定された位置にJsonNumber
として値を配列に追加します。default JsonArrayBuilder
add(int index, JsonArrayBuilder builder)
配列ビルダーから指定された位置の配列にJsonArray
を追加します。default JsonArrayBuilder
add(int index, JsonObjectBuilder builder)
オブジェクトビルダーのJsonObject
を、指定された位置の配列に追加します。default JsonArrayBuilder
add(int index, JsonValue value)
配列の指定された位置に値を挿入します。default JsonArrayBuilder
add(int index, StringSE value)
指定された位置にJsonString
として値を配列に追加します。default JsonArrayBuilder
add(int index, BigDecimalSE value)
指定された位置にJsonNumber
として値を配列に追加します。default JsonArrayBuilder
add(int index, BigIntegerSE value)
指定された位置にJsonNumber
として値を配列に追加します。JsonArrayBuilder
add(long value)
値をJsonNumber
として配列に追加します。JsonArrayBuilder
add(JsonArrayBuilder builder)
配列ビルダーから配列にJsonArray
を追加します。JsonArrayBuilder
add(JsonObjectBuilder builder)
オブジェクトビルダーから配列にJsonObject
を追加します。JsonArrayBuilder
add(JsonValue value)
配列に値を追加します。JsonArrayBuilder
add(StringSE value)
値をJsonString
として配列に追加します。JsonArrayBuilder
add(BigDecimalSE value)
値をJsonNumber
として配列に追加します。JsonArrayBuilder
add(BigIntegerSE value)
値をJsonNumber
として配列に追加します。default JsonArrayBuilder
addAll(JsonArrayBuilder builder)
指定された配列ビルダーの配列のすべての要素を配列に追加します。JsonArrayBuilder
addNull()
JsonValue.NULL
値を配列に追加します。default JsonArrayBuilder
addNull(int index)
JsonValue.NULL
値を配列の指定された位置に追加します。JsonArray
build()
現在の配列を返します。default JsonArrayBuilder
remove(int index)
指定された位置にある配列の値を削除します。default JsonArrayBuilder
set(int index, boolean value)
配列内の値を、指定された位置のJsonValue.TRUE
またはJsonValue.FALSE
値で置き換えます。default JsonArrayBuilder
set(int index, double value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, int value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, long value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, JsonArrayBuilder builder)
配列内の値を、指定された位置にある配列ビルダーからのJsonArray
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, JsonObjectBuilder builder)
配列内の値を、指定された位置にあるオブジェクトビルダーからのJsonObject
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, JsonValue value)
配列内の値を、指定された位置にある指定された値で置き換えます。default JsonArrayBuilder
set(int index, StringSE value)
配列内の値を、指定された位置のJsonString
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, BigDecimalSE value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。default JsonArrayBuilder
set(int index, BigIntegerSE value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。default JsonArrayBuilder
setNull(int index)
配列内の値を、指定された位置のJsonValue.NULL
値で置き換えます。
メソッドの詳細
add
JsonArrayBuilder add(JsonValue value)
配列に値を追加します。- パラメーター:
value
- JSON 値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合
add
JsonArrayBuilder add(StringSE value)
値をJsonString
として配列に追加します。- パラメーター:
value
- 文字列値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合
add
JsonArrayBuilder add(BigDecimalSE value)
値をJsonNumber
として配列に追加します。- パラメーター:
value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合- 関連事項:
JsonNumber
add
JsonArrayBuilder add(BigIntegerSE value)
値をJsonNumber
として配列に追加します。- パラメーター:
value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合- 関連事項:
JsonNumber
add
JsonArrayBuilder add(int value)
値をJsonNumber
として配列に追加します。- パラメーター:
value
- 数値- 戻り値:
- この配列ビルダー
- 関連事項:
JsonNumber
add
JsonArrayBuilder add(long value)
値をJsonNumber
として配列に追加します。- パラメーター:
value
- 数値- 戻り値:
- この配列ビルダー
- 関連事項:
JsonNumber
add
JsonArrayBuilder add(double value)
値をJsonNumber
として配列に追加します。- パラメーター:
value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NumberFormatExceptionSE
- 値が非数(NaN)または無限大の場合- 関連事項:
JsonNumber
add
JsonArrayBuilder add(boolean value)
JsonValue.TRUE
またはJsonValue.FALSE
値を配列に追加します。- パラメーター:
value
- ブール値- 戻り値:
- この配列ビルダー
addNull
JsonArrayBuilder addNull()
JsonValue.NULL
値を配列に追加します。- 戻り値:
- この配列ビルダー
add
JsonArrayBuilder add(JsonObjectBuilder builder)
オブジェクトビルダーから配列にJsonObject
を追加します。- パラメーター:
builder
- オブジェクトビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合
add
JsonArrayBuilder add(JsonArrayBuilder builder)
配列ビルダーから配列にJsonArray
を追加します。- パラメーター:
builder
- 配列ビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合
addAll
default JsonArrayBuilder addAll(JsonArrayBuilder builder)
指定された配列ビルダーの配列のすべての要素を配列に追加します。- パラメーター:
builder
- 配列ビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合- 導入:
- 1.1
add
default JsonArrayBuilder add(int index, JsonValue value)
配列の指定された位置に値を挿入します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- JSON 値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
add
default JsonArrayBuilder add(int index, StringSE value)
指定された位置にJsonString
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 文字列値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
add
default JsonArrayBuilder add(int index, BigDecimalSE value)
指定された位置にJsonNumber
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
add
default JsonArrayBuilder add(int index, BigIntegerSE value)
指定された位置にJsonNumber
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
add
default JsonArrayBuilder add(int index, int value)
指定された位置にJsonNumber
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
add
default JsonArrayBuilder add(int index, long value)
指定された位置にJsonNumber
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
add
default JsonArrayBuilder add(int index, double value)
指定された位置にJsonNumber
として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NumberFormatExceptionSE
- 値が非数(NaN)または無限大の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
add
default JsonArrayBuilder add(int index, boolean value)
JsonValue.TRUE
またはJsonValue.FALSE
値を配列の指定された位置に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置value
- ブール値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
addNull
default JsonArrayBuilder addNull(int index)
JsonValue.NULL
値を配列の指定された位置に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
add
default JsonArrayBuilder add(int index, JsonObjectBuilder builder)
オブジェクトビルダーのJsonObject
を、指定された位置の配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置builder
- オブジェクトビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
add
default JsonArrayBuilder add(int index, JsonArrayBuilder builder)
配列ビルダーから指定された位置の配列にJsonArray
を追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。- パラメーター:
index
- 配列内の位置builder
- 配列ビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index > array size)
の範囲外の場合- 導入:
- 1.1
set
default JsonArrayBuilder set(int index, JsonValue value)
配列内の値を、指定された位置にある指定された値で置き換えます。- パラメーター:
index
- 配列内の位置value
- JSON 値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
set
default JsonArrayBuilder set(int index, StringSE value)
配列内の値を、指定された位置のJsonString
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 文字列値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
set
default JsonArrayBuilder set(int index, BigDecimalSE value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
set
default JsonArrayBuilder set(int index, BigIntegerSE value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定された値が null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
set
default JsonArrayBuilder set(int index, int value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
set
default JsonArrayBuilder set(int index, long value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
set
default JsonArrayBuilder set(int index, double value)
配列内の値を、指定された位置のJsonNumber
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置value
- 数値- 戻り値:
- この配列ビルダー
- 例外:
NumberFormatExceptionSE
- 値が非数(NaN)または無限大の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
- 関連事項:
JsonNumber
set
default JsonArrayBuilder set(int index, boolean value)
配列内の値を、指定された位置のJsonValue.TRUE
またはJsonValue.FALSE
値で置き換えます。- パラメーター:
index
- 配列内の位置value
- ブール値- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
setNull
default JsonArrayBuilder setNull(int index)
配列内の値を、指定された位置のJsonValue.NULL
値で置き換えます。- パラメーター:
index
- 配列内の位置- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
set
default JsonArrayBuilder set(int index, JsonObjectBuilder builder)
配列内の値を、指定された位置にあるオブジェクトビルダーからのJsonObject
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置builder
- オブジェクトビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
set
default JsonArrayBuilder set(int index, JsonArrayBuilder builder)
配列内の値を、指定された位置にある配列ビルダーからのJsonArray
として指定された値に置き換えます。- パラメーター:
index
- 配列内の位置builder
- 配列ビルダー- 戻り値:
- この配列ビルダー
- 例外:
NullPointerExceptionSE
- 指定されたビルダーが null の場合IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
remove
default JsonArrayBuilder remove(int index)
指定された位置にある配列の値を削除します。後続の値を左にシフトします(インデックスから 1 を減算します)。- パラメーター:
index
- 配列内の位置- 戻り値:
- この配列ビルダー
- 例外:
IndexOutOfBoundsExceptionSE
- インデックスが(index < 0 || index >= array size)
の範囲外の場合- 導入:
- 1.1
build
JsonArray build()
現在の配列を返します。- 戻り値:
- 現在の JSON 配列