javax.json

Class JsonPatch

java.lang.Object

javax.json.JsonPatch

public class JsonPatch
extends Object

This class is an immutable representation of a JSON Patch as specified in RFC 6902.

A JsonPatch can be instantiated with JsonPatch(JsonArray) by specifying the patch operations in a JSON Patch. Alternately, it can also be constructed with a JsonPatchBuilder.

The following illustrates both approaches.

1. Construct a JsonPatch with a JSON Patch.

   JsonArray contacts = ... // The target to be patched
   JsonArray patch = ...  ; // JSON Patch
   JsonPatch jsonpatch = new JsonPatch(patch);
   JsonArray result = jsonpatch.apply(contacts);
  

2. Construct a JsonPatch with JsonPatchBuilder.

   JsonPatchBuilder builder = new JsonPatchBuilder();
   JsonArray result = builder.add("/John/phones/office", "1234-567")
                             .remove("/Amy/age")
                             .apply(contacts);
  

Constructor Summary

Constructors

Constructor and Description
JsonPatch(JsonArray patch) Constructs a JsonPatch

Method Summary

Modifier and Type	Method and Description
JsonArray	apply(JsonArray target) Applies the patch operations to the specified target.
JsonObject	apply(JsonObject target) Applies the patch operations to the specified target.
JsonStructure	apply(JsonStructure target) Applies the patch operations to the specified target.
static JsonArray	diff(JsonStructure source, JsonStructure target) Generates a JSON Patch from the source and target JsonStructure.
boolean	equals(Object obj) Compares this JsonPatch with another object.
int	hashCode() Returns the hash code value for this JsonPatch.
String	toString() Returns the JSON Patch text

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JsonPatch

public JsonPatch(JsonArray patch)

Constructs a JsonPatch

Parameters:

patch - the JSON Patch

Method Detail

equals

public boolean equals(Object obj)

Compares this JsonPatch with another object.

Overrides:

equals in class Object

Parameters:

obj - the object to compare this JsonPatch against

Returns:

true if the given object is a JsonPatch with the same reference tokens as this one, false otherwise.

hashCode

public int hashCode()

Returns the hash code value for this JsonPatch.

Overrides:

hashCode in class Object

Returns:

the hash code value for this JsonPatch object

toString

public String toString()

Returns the JSON Patch text

Overrides:

toString in class Object

Returns:

the JSON Patch text

apply

public JsonStructure apply(JsonStructure target)

Applies the patch operations to the specified target. The target is not modified by the patch.

Parameters:

target - the target to apply the patch operations

Returns:

the transformed target after the patch

Throws:

JsonException - if the supplied JSON Patch is malformed or if it contains references to non-existing members

apply

public JsonObject apply(JsonObject target)

Applies the patch operations to the specified target.

Parameters:

target - the target to apply the patch operations

Returns:

the transformed target after the patch

Throws:

JsonException - if the supplied JSON Patch is malformed or if it contains references to non-existing members

apply

public JsonArray apply(JsonArray target)

Applies the patch operations to the specified target.

Parameters:

target - the target to apply the patch operations

Returns:

the transformed target after the patch

Throws:

JsonException - if the supplied JSON Patch is malformed or if it contains references to non-existing members

diff

public static JsonArray diff(JsonStructure source,
                             JsonStructure target)

Generates a JSON Patch from the source and target JsonStructure. The generated JSON Patch need not be unique.

Parameters:

source - the source

target - the target, must be the same type as the source

Returns:

a JSON Patch which when applied to the source, yields the target