Package javax.json

Interface JsonPatch

public interface JsonPatch

JsonPatch is a format for expressing a sequence of operations to apply on a target JSON document.

A JsonPatch is an array of 'operations' in the form e.g.

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

The 'operations' are performed in the order they are in the JsonPatch and applied to the 'result' JSON document from the previous operation.

Since:

1.1

See Also:

JsonPatch.Operation

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JsonPatch.Operation	An enumeration of available operations for JsonPatch.

Method Summary

Modifier and Type	Method	Description
<T extends JsonStructure> T	apply(T target)	Applies the JsonPatch to the given target.
JsonArray	toJsonArray()

Method Detail

apply

<T extends JsonStructure> T apply(T target)

Applies the JsonPatch to the given target. If the given target is null a NullPointerException will be thrown.

Parameters:

target - - the target to apply the JsonPatch

Returns:

'patched' JsonStructure

Throws:

java.lang.NullPointerException - if target is null

toJsonArray

JsonArray toJsonArray()

Returns:

the JsonPatch as JsonArray