パッケージ 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
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド デフォルトメソッド 修飾子と型 メソッド 説明 JsonArrayBuilderadd(boolean value)JsonValue.TRUEまたはJsonValue.FALSE値を配列に追加します。JsonArrayBuilderadd(double value)値をJsonNumberとして配列に追加します。JsonArrayBuilderadd(int value)値をJsonNumberとして配列に追加します。default JsonArrayBuilderadd(int index, boolean value)JsonValue.TRUEまたはJsonValue.FALSE値を配列の指定された位置に追加します。default JsonArrayBuilderadd(int index, double value)指定された位置にJsonNumberとして値を配列に追加します。default JsonArrayBuilderadd(int index, int value)指定された位置にJsonNumberとして値を配列に追加します。default JsonArrayBuilderadd(int index, long value)指定された位置にJsonNumberとして値を配列に追加します。default JsonArrayBuilderadd(int index, JsonArrayBuilder builder)配列ビルダーから指定された位置の配列にJsonArrayを追加します。default JsonArrayBuilderadd(int index, JsonObjectBuilder builder)オブジェクトビルダーのJsonObjectを、指定された位置の配列に追加します。default JsonArrayBuilderadd(int index, JsonValue value)配列の指定された位置に値を挿入します。default JsonArrayBuilderadd(int index, StringSE value)指定された位置にJsonStringとして値を配列に追加します。default JsonArrayBuilderadd(int index, BigDecimalSE value)指定された位置にJsonNumberとして値を配列に追加します。default JsonArrayBuilderadd(int index, BigIntegerSE value)指定された位置にJsonNumberとして値を配列に追加します。JsonArrayBuilderadd(long value)値をJsonNumberとして配列に追加します。JsonArrayBuilderadd(JsonArrayBuilder builder)配列ビルダーから配列にJsonArrayを追加します。JsonArrayBuilderadd(JsonObjectBuilder builder)オブジェクトビルダーから配列にJsonObjectを追加します。JsonArrayBuilderadd(JsonValue value)配列に値を追加します。JsonArrayBuilderadd(StringSE value)値をJsonStringとして配列に追加します。JsonArrayBuilderadd(BigDecimalSE value)値をJsonNumberとして配列に追加します。JsonArrayBuilderadd(BigIntegerSE value)値をJsonNumberとして配列に追加します。default JsonArrayBuilderaddAll(JsonArrayBuilder builder)指定された配列ビルダーの配列のすべての要素を配列に追加します。JsonArrayBuilderaddNull()JsonValue.NULL値を配列に追加します。default JsonArrayBuilderaddNull(int index)JsonValue.NULL値を配列の指定された位置に追加します。JsonArraybuild()現在の配列を返します。default JsonArrayBuilderremove(int index)指定された位置にある配列の値を削除します。default JsonArrayBuilderset(int index, boolean value)配列内の値を、指定された位置のJsonValue.TRUEまたはJsonValue.FALSE値で置き換えます。default JsonArrayBuilderset(int index, double value)配列内の値を、指定された位置のJsonNumberとして指定された値に置き換えます。default JsonArrayBuilderset(int index, int value)配列内の値を、指定された位置のJsonNumberとして指定された値に置き換えます。default JsonArrayBuilderset(int index, long value)配列内の値を、指定された位置のJsonNumberとして指定された値に置き換えます。default JsonArrayBuilderset(int index, JsonArrayBuilder builder)配列内の値を、指定された位置にある配列ビルダーからのJsonArrayとして指定された値に置き換えます。default JsonArrayBuilderset(int index, JsonObjectBuilder builder)配列内の値を、指定された位置にあるオブジェクトビルダーからのJsonObjectとして指定された値に置き換えます。default JsonArrayBuilderset(int index, JsonValue value)配列内の値を、指定された位置にある指定された値で置き換えます。default JsonArrayBuilderset(int index, StringSE value)配列内の値を、指定された位置のJsonStringとして指定された値に置き換えます。default JsonArrayBuilderset(int index, BigDecimalSE value)配列内の値を、指定された位置のJsonNumberとして指定された値に置き換えます。default JsonArrayBuilderset(int index, BigIntegerSE value)配列内の値を、指定された位置のJsonNumberとして指定された値に置き換えます。default JsonArrayBuildersetNull(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 配列