パッケージ 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 を値として使用することできませ

関連事項:
  • 方法の詳細

    • add

      配列に値を追加します。
      パラメーター:
      value - JSON 値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
    • add

      値を JsonString として配列に追加します。
      パラメーター:
      value - 文字列値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
    • add

      値を JsonNumber として配列に追加します。
      パラメーター:
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
      関連事項:
    • add

      値を JsonNumber として配列に追加します。
      パラメーター:
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
      関連事項:
    • add

      JsonArrayBuilder add(int value)
      値を JsonNumber として配列に追加します。
      パラメーター:
      value - 数値
      戻り値:
      この配列ビルダー
      関連事項:
    • add

      JsonArrayBuilder add(long value)
      値を JsonNumber として配列に追加します。
      パラメーター:
      value - 数値
      戻り値:
      この配列ビルダー
      関連事項:
    • add

      JsonArrayBuilder add(double value)
      値を JsonNumber として配列に追加します。
      パラメーター:
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NumberFormatExceptionSE - 値が非数(NaN)または無限大の場合
      関連事項:
    • add

      JsonArrayBuilder add(boolean value)
      JsonValue.TRUE または JsonValue.FALSE 値を配列に追加します。
      パラメーター:
      value - ブール値
      戻り値:
      この配列ビルダー
    • addNull

      JsonArrayBuilder addNull()
      JsonValue.NULL 値を配列に追加します。
      戻り値:
      この配列ビルダー
    • add

      オブジェクトビルダーから配列に JsonObject を追加します。
      パラメーター:
      builder - オブジェクトビルダー
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定されたビルダーが null の場合
    • add

      配列ビルダーから配列に 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
      関連事項:
    • add

      default JsonArrayBuilder add(int index, BigIntegerSE value)
      指定された位置に JsonNumber として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index > array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • add

      default JsonArrayBuilder add(int index, int value)
      指定された位置に JsonNumber として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index > array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • add

      default JsonArrayBuilder add(int index, long value)
      指定された位置に JsonNumber として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index > array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • add

      default JsonArrayBuilder add(int index, double value)
      指定された位置に JsonNumber として値を配列に追加します。現在その位置にある値(ある場合)と後続の値を右にシフトします(インデックスに 1 を加えます)。インデックスは 0 から始まります。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NumberFormatExceptionSE - 値が非数(NaN)または無限大の場合
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index > array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • 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
      関連事項:
    • set

      default JsonArrayBuilder set(int index, BigIntegerSE value)
      配列内の値を、指定された位置の JsonNumber として指定された値に置き換えます。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NullPointerExceptionSE - 指定された値が null の場合
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index >= array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • set

      default JsonArrayBuilder set(int index, int value)
      配列内の値を、指定された位置の JsonNumber として指定された値に置き換えます。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index >= array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • set

      default JsonArrayBuilder set(int index, long value)
      配列内の値を、指定された位置の JsonNumber として指定された値に置き換えます。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index >= array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • set

      default JsonArrayBuilder set(int index, double value)
      配列内の値を、指定された位置の JsonNumber として指定された値に置き換えます。
      パラメーター:
      index - 配列内の位置
      value - 数値
      戻り値:
      この配列ビルダー
      例外:
      NumberFormatExceptionSE - 値が非数(NaN)または無限大の場合
      IndexOutOfBoundsExceptionSE - インデックスが (index < 0 || index >= array size) の範囲外の場合
      導入:
      1.1
      関連事項:
    • 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 配列