IObjectAdapter Schnittstelle

Definition

Definiert die Vorgänge, die für ein JSON-Patchdokument ausgeführt werden können.

public interface class IObjectAdapter
public interface IObjectAdapter
type IObjectAdapter = interface
Public Interface IObjectAdapter
Abgeleitet

Methoden

Add(Operation, Object)

Mithilfe des Vorgangs "add" wird ein neuer Wert in den Stamm des Zieldokuments, in das Zielarray am angegebenen gültigen Index oder in ein Zielobjekt am angegebenen Speicherort eingefügt.

Beim Hinzufügen zu Arrays DARF der angegebene Index NICHT größer als die Anzahl der Elemente im Array sein. Um den Wert an das Array anzufügen, wird der Index des Zeichens "-" verwendet (siehe [RFC6901]).

Wenn ein Objektmember nicht bereits vorhanden ist, wird dem Objekt an der angegebenen Position ein neues Element hinzugefügt oder wenn ein Objektmember vorhanden ist, der Wert dieses Elements ersetzt.

Das Vorgangsobjekt MUSS einen "Wert"-Member enthalten, dessen Inhalt den hinzuzufügenden Wert angibt.

Beispiel:

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

Siehe RFC 6902 https://tools.ietf.org/html/rfc6902#page-4

Copy(Operation, Object)

Mithilfe des Kopiervorgangs wird ein Wert von einem angegebenen Speicherort an den Zielspeicherort kopiert.

Das Vorgangsobjekt MUSS einen "from"-Member enthalten, der auf den Speicherort im Zieldokument verweist, aus dem der Wert kopiert werden soll.

Der Speicherort "von" MUSS vorhanden sein, damit der Vorgang erfolgreich ist.

Beispiel:

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

Siehe RFC 6902 https://tools.ietf.org/html/rfc6902#page-7

Move(Operation, Object)

Mithilfe des Vorgangs "verschieben" wird der Wert an einer angegebenen Position entfernt und dem Zielspeicherort hinzugefügt.

Das Vorgangsobjekt MUSS ein "from"-Element enthalten, das auf den Speicherort im Zieldokument verweist, aus dem der Wert verschoben werden soll.

Der Speicherort "von" MUSS vorhanden sein, damit der Vorgang erfolgreich ist.

Beispiel:

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

Ein Standort kann nicht in eines seiner untergeordneten Elemente verschoben werden.

Siehe RFC 6902 https://tools.ietf.org/html/rfc6902#page-6

Remove(Operation, Object)

Mit dem Vorgang "entfernen" wird der Wert am Zielspeicherort entfernt.

Der Zielspeicherort MUSS vorhanden sein, damit der Vorgang erfolgreich ist.

Beispiel:

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

Wenn Sie ein Element aus einem Array entfernen, werden alle Elemente über dem angegebenen Index um eine Position nach links verschoben.

Siehe RFC 6902 https://tools.ietf.org/html/rfc6902#page-6

Replace(Operation, Object)

Mithilfe des Vorgangs "replace" wird der Wert am Zielort durch einen neuen Wert ersetzt. Das Vorgangsobjekt MUSS einen "Wert"-Member enthalten, der den Ersetzungswert angibt.

Der Zielspeicherort MUSS vorhanden sein, damit der Vorgang erfolgreich ist.

Beispiel:

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

Siehe RFC 6902 https://tools.ietf.org/html/rfc6902#page-6

Gilt für: