Share via


IObjectAdapter インターフェイス

定義

JSON パッチ ドキュメントで実行できる操作を定義します。

public interface class IObjectAdapter
public interface IObjectAdapter
type IObjectAdapter = interface
Public Interface IObjectAdapter
派生

メソッド

Add(Operation, Object)

"追加" 操作を使用すると、新しい値がターゲット ドキュメントのルート、指定した有効なインデックスのターゲット配列、または指定した場所にあるターゲット オブジェクトに挿入されます。

配列にを追加する場合、指定したインデックスは配列内の要素の数を超えてはなりません。 配列に値を追加するには、"-" 文字のインデックスが使用されます ([RFC6901]を参照)。

オブジェクトにを追加するときに、オブジェクト メンバーがまだ存在しない場合は、指定した場所にあるオブジェクトに新しいメンバーが追加されるか、オブジェクト メンバーが存在する場合は、そのメンバーの値が置き換えられます。

操作オブジェクトには、追加する値を指定するコンテンツを持つ "value" メンバーが含まれている必要があります。

例:

{ "op": "add", "path": "/a/b/c", "value": [ "foo", "bar" ] }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-4

Copy(Operation, Object)

"コピー" 操作を使用すると、指定した場所からターゲットの場所に値がコピーされます。

操作オブジェクトには、値のコピー元となるターゲット ドキュメント内の場所を参照する "from" メンバーが含まれている必要があります。

操作を成功させるには、"from" の場所が存在する必要があります。

例:

{ "op": "copy", "from": "/a/b/c", "path": "/a/b/e" }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-7

Move(Operation, Object)

"移動" 操作を使用すると、指定した場所にある値が削除され、ターゲットの場所に追加されます。

操作オブジェクトには、値の移動元となるターゲット ドキュメント内の場所を参照する "from" メンバーが含まれている必要があります。

操作を成功させるには、"from" の場所が存在する必要があります。

例:

{ "op": "move", "from": "/a/b/c", "path": "/a/b/d" }

場所をその子の 1 つに移動することはできません。

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

Remove(Operation, Object)

"remove" 操作を使用すると、ターゲットの場所にある値が削除されます。

操作を成功させるには、ターゲットの場所が存在する必要があります。

例:

{ "op": "remove", "path": "/a/b/c" }

配列から要素を削除すると、指定したインデックスの上にある要素は 1 つ左にシフトされます。

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

Replace(Operation, Object)

"置換" 操作を使用すると、ターゲットの場所にある値が新しい値に置き換えられます。 操作オブジェクトには、置換値を指定する "value" メンバーが含まれている必要があります。

操作を成功させるには、ターゲットの場所が存在する必要があります。

例:

{ "op": "replace", "path": "/a/b/c", "value": 42 }

RFC 6902 を参照してください https://tools.ietf.org/html/rfc6902#page-6

適用対象