io.progix.jackson

Class JsonPatch

java.lang.Object

io.progix.jackson.JsonPatch

public class JsonPatch
extends java.lang.Object

Helper class that provides methods to apply JSON patches to JSON documents.

Constructor Summary

Constructors

Constructor and Description
JsonPatch()

Method Summary

Methods

Modifier and Type	Method and Description
static com.fasterxml.jackson.databind.JsonNode	add(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.databind.JsonNode value, com.fasterxml.jackson.databind.JsonNode document) Applies an add operation to a JSON document.
static com.fasterxml.jackson.databind.JsonNode	apply(JsonPatchOperation[] patchOperations, com.fasterxml.jackson.databind.JsonNode rootDocument) Performs a series of JsonPatchOperation on a target JsonNode patch document.
static com.fasterxml.jackson.databind.JsonNode	copy(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.core.JsonPointer from, com.fasterxml.jackson.databind.JsonNode document) Applies a copy operation to a JSON document.
static com.fasterxml.jackson.databind.JsonNode	move(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.core.JsonPointer from, com.fasterxml.jackson.databind.JsonNode document) Applies a move operation to a JSON document.
static com.fasterxml.jackson.databind.JsonNode	remove(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.databind.JsonNode document) Applies a remove operation to a JSON document.
static com.fasterxml.jackson.databind.JsonNode	replace(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.databind.JsonNode value, com.fasterxml.jackson.databind.JsonNode document) Applies an replace operation to a JSON document.
static void	test(com.fasterxml.jackson.core.JsonPointer path, com.fasterxml.jackson.databind.JsonNode value, com.fasterxml.jackson.databind.JsonNode document) Performs a test operation to a JSON document.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonPatch

public JsonPatch()

Method Detail

apply

public static com.fasterxml.jackson.databind.JsonNode apply(JsonPatchOperation[] patchOperations,
                                            com.fasterxml.jackson.databind.JsonNode rootDocument)
                                                     throws JsonPatchFailedException

Performs a series of JsonPatchOperation on a target JsonNode patch document.

Note that the patch document is not modified.

Parameters:

patchOperations - the JsonPatchOperation's to be performed

rootDocument - the JSON document to be patched

Returns:

the patched document

Throws:

JsonPatchFailedException - if there were any issues applying the patch

add

public static com.fasterxml.jackson.databind.JsonNode add(com.fasterxml.jackson.core.JsonPointer path,
                                          com.fasterxml.jackson.databind.JsonNode value,
                                          com.fasterxml.jackson.databind.JsonNode document)
                                                   throws JsonPatchFailedException

Applies an add operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation of the target path to perform the add operation

value - JsonNode representation of value to add

document - the JSON document

Returns:

the modified JSON document

Throws:

JsonPatchFailedException - if there are any problems patching the document

copy

public static com.fasterxml.jackson.databind.JsonNode copy(com.fasterxml.jackson.core.JsonPointer path,
                                           com.fasterxml.jackson.core.JsonPointer from,
                                           com.fasterxml.jackson.databind.JsonNode document)
                                                    throws JsonPatchFailedException

Applies a copy operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation of target path in JSON document to copy source entity to

from - JsonPointer representation of document path for source entity to copy

document - the JSON document

Returns:

the modified JSON document

Throws:

JsonPatchFailedException - if there are any problems patching the document

move

public static com.fasterxml.jackson.databind.JsonNode move(com.fasterxml.jackson.core.JsonPointer path,
                                           com.fasterxml.jackson.core.JsonPointer from,
                                           com.fasterxml.jackson.databind.JsonNode document)
                                                    throws JsonPatchFailedException

Applies a move operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation of target path in JSON document to move source entity to

from - JsonPointer representation of document path for source entity to move

document - the JSON document

Returns:

the modified JSON document

Throws:

JsonPatchFailedException - if there any problems patching the document

remove

public static com.fasterxml.jackson.databind.JsonNode remove(com.fasterxml.jackson.core.JsonPointer path,
                                             com.fasterxml.jackson.databind.JsonNode document)
                                                      throws JsonPatchFailedException

Applies a remove operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation of target path in JSON document to remove

document - the JSON document

Returns:

the modified JSON document

Throws:

JsonPatchFailedException - if there are any problems patching the document

replace

public static com.fasterxml.jackson.databind.JsonNode replace(com.fasterxml.jackson.core.JsonPointer path,
                                              com.fasterxml.jackson.databind.JsonNode value,
                                              com.fasterxml.jackson.databind.JsonNode document)
                                                       throws JsonPatchFailedException

Applies an replace operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation the target path to perform the replace operation

value - JsonNode representation of value to replace

document - the JSON document

Returns:

the modified JSON document

Throws:

JsonPatchFailedException - if there are any problems patching the document

test

public static void test(com.fasterxml.jackson.core.JsonPointer path,
        com.fasterxml.jackson.databind.JsonNode value,
        com.fasterxml.jackson.databind.JsonNode document)
                 throws JsonPatchFailedException

Performs a test operation to a JSON document.

Note this method does not modify given JSON document.

Parameters:

path - JsonPointer representation of the target path to perform the test operation

value - JsonNode representation of value to test

document - the JSON document

Throws:

JsonPatchFailedException - if there are any problems patching the document or if the equality test fails.