ObjectAdapter Class

Namespace
Microsoft.AspNetCore.JsonPatch.Adapters
Assemblies
  • Microsoft.AspNetCore.JsonPatch

Syntax

public class ObjectAdapter : IObjectAdapter
class Microsoft.AspNetCore.JsonPatch.Adapters.ObjectAdapter

Constructors

ObjectAdapter(Newtonsoft.Json.Serialization.IContractResolver, System.Action<Microsoft.AspNetCore.JsonPatch.JsonPatchError>)

Initializes a new instance of Microsoft.AspNetCore.JsonPatch.Adapters.ObjectAdapter.

Arguments: 
public ObjectAdapter(IContractResolver contractResolver, Action<JsonPatchError> logErrorAction)

Methods

Add(Microsoft.AspNetCore.JsonPatch.Operations.Operation, System.Object)

The “add” operation performs one of the following functions, depending upon what the target location references:

o If the target location specifies an array index, a new value is
inserted into the array at the specified index.
o If the target location specifies an object member that does not
already exist, a new member is added to the object.
o If the target location specifies an object member that does exist,
that member’s value is replaced.

The operation object MUST contain a “value” member whose content specifies the value to be added.

For example:

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

When the operation is applied, the target location MUST reference one of:

o The root of the target document - whereupon the specified value
becomes the entire content of the target document.
o A member to add to an existing object - whereupon the supplied
value is added to that object at the indicated location. If the member already exists, it is replaced by the specified value.
o An element to add to an existing array - whereupon the supplied
value is added to the array at the indicated location. Any elements at or above the specified index are shifted one position to the right. The specified index MUST NOT be greater than the number of elements in the array. If the “-” character is used to index the end of the array (see [RFC6901]), this has the effect of appending the value to the array.

Because this operation is designed to add to existing objects and arrays, its target location will often not exist. Although the pointer’s error handling algorithm will thus be invoked, this specification defines the error handling behavior for “add” pointers to ignore that error and add the value as specified.

However, the object itself or an array containing it does need to exist, and it remains an error for that not to be the case. For example, an “add” with a target location of “/a/b” starting with this document:

{ “a”: { “foo”: 1 } }

is not an error, because “a” exists, and “b” will be added to its value. It is an error in this document:

{ “q”: { “bar”: 2 } }

because “a” does not exist.

Arguments: 
public void Add(Operation operation, object objectToApplyTo)
Copy(Microsoft.AspNetCore.JsonPatch.Operations.Operation, System.Object)

The “copy” operation copies the value at a specified location to the target location.

The operation object MUST contain a “from” member, which is a string containing a JSON Pointer value that references the location in the target document to copy the value from.

The “from” location MUST exist for the operation to be successful.

For example:

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

This operation is functionally identical to an “add” operation at the target location using the value specified in the “from” member.

Note: even though it’s the same functionally, we do not call add with the value specified in from for performance reasons (multiple checks of same requirements).

Arguments: 
public void Copy(Operation operation, object objectToApplyTo)
Move(Microsoft.AspNetCore.JsonPatch.Operations.Operation, System.Object)

The “move” operation removes the value at a specified location and adds it to the target location.

The operation object MUST contain a “from” member, which is a string containing a JSON Pointer value that references the location in the target document to move the value from.

The “from” location MUST exist for the operation to be successful.

For example:

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

This operation is functionally identical to a “remove” operation on the “from” location, followed immediately by an “add” operation at the target location with the value that was just removed.

The “from” location MUST NOT be a proper prefix of the “path” location; i.e., a location cannot be moved into one of its children.

Arguments: 
public void Move(Operation operation, object objectToApplyTo)
Remove(Microsoft.AspNetCore.JsonPatch.Operations.Operation, System.Object)

The “remove” operation removes the value at the target location.

The target location MUST exist for the operation to be successful.

For example:

{ “op”: “remove”, “path”: “/a/b/c” }

If removing an element from an array, any elements above the specified index are shifted one position to the left.

Arguments: 
public void Remove(Operation operation, object objectToApplyTo)
Replace(Microsoft.AspNetCore.JsonPatch.Operations.Operation, System.Object)

The “replace” operation replaces the value at the target location with a new value. The operation object MUST contain a “value” member whose content specifies the replacement value.

The target location MUST exist for the operation to be successful.

For example:

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

This operation is functionally identical to a “remove” operation for a value, followed immediately by an “add” operation at the same location with the replacement value.

Note: even though it’s the same functionally, we do not call remove + add for performance reasons (multiple checks of same requirements).

Arguments: 
public void Replace(Operation operation, object objectToApplyTo)

Properties

Microsoft.AspNetCore.JsonPatch.Adapters.ObjectAdapter.ContractResolver

Gets or sets the Newtonsoft.Json.Serialization.IContractResolver.

Return type:Newtonsoft.Json.Serialization.IContractResolver 
public IContractResolver ContractResolver { get; }
Microsoft.AspNetCore.JsonPatch.Adapters.ObjectAdapter.LogErrorAction

Action for logging Microsoft.AspNetCore.JsonPatch.JsonPatchError.

Return type:System.Action<Microsoft.AspNetCore.JsonPatch.JsonPatchError> 
public Action<JsonPatchError> LogErrorAction { get; }