パッケージ jakarta.json

インターフェース JsonPatch


public interface JsonPatch

このインターフェースは、RFC 6902 で定義されている JSON パッチの不変の実装を表します。

JSON パッチでパッチ操作を指定することにより、JsonPatch を Json.createPatch(JsonArray) でインスタンス化できます。または、JsonPatchBuilder で構築することもできます。

以下に両方のアプローチを示します。

1. JSON パッチを使用して JsonPatch を構築します。


   JsonArray contacts = ... // The target to be patched
   JsonArray patch = ...  ; // JSON Patch
   JsonPatch jsonpatch = Json.createPatch(patch);
   JsonArray result = jsonpatch.apply(contacts);
  
2. JsonPatchBuilder を使用して JsonPatch を作成します。

   JsonPatchBuilder builder = Json.createPatchBuilder();
   JsonArray result = builder.add("/John/phones/office", "1234-567")
                             .remove("/Amy/age")
                             .build()
                             .apply(contacts);
  
導入:
1.1
関連事項:
  • ネストされたクラスのサマリー

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static enum
    この列挙型は、RFC 6902 で定義されている有効な JSON パッチ操作のリストを表します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    <T extends JsonStructure>
    T
    apply(T target)
    指定された target にパッチ操作を適用します。
    JsonPatch を JsonArray として返します。
  • メソッドの詳細

    • apply

      <T extends JsonStructure> T apply(T target)
      指定された target にパッチ操作を適用します。ターゲットはパッチによって変更されません。
      型パラメーター:
      T - ターゲット型。JsonStructure のサブ型である必要があります
      パラメーター:
      target - パッチ操作を適用するターゲット
      戻り値:
      パッチ後の変換されたターゲット
      例外:
      JsonException - 提供された JSON パッチの形式が正しくない場合、または存在しないメンバーへの参照が含まれている場合
    • toJsonArray

      JsonArray toJsonArray()
      JsonPatch を JsonArray として返します。
      戻り値:
      この JsonPatch は JsonArray として