javax.json

Class JsonPatchBuilder

java.lang.Object

javax.json.JsonPatchBuilder

public class JsonPatchBuilder
extends Object

A builder for constructing a JSON Patch by adding JSON Patch operations incrementatlly.

The following illustrates the approach.

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

The result is equivalent to the following JSON Patch.

 [
    {"op" = "add", "path" = "/John/phones/office", "value" = "1234-567"},
    {"op" = "remove", "path" = "/Amy/age"}
 ] 

Constructor Summary

Constructors

Constructor and Description
JsonPatchBuilder() Creates JsonPatchBuilder with empty JSON Patch
JsonPatchBuilder(JsonArray patch) Creates a JsonPatchBuilder, starting with the specified JSON Patch

Method Summary

Modifier and Type	Method and Description
JsonPatchBuilder	add(String path, boolean value) Adds an "add" JSON Patch operation
JsonPatchBuilder	add(String path, int value) Adds an "add" JSON Patch operation
JsonPatchBuilder	add(String path, JsonValue value) Adds an "add" JSON Patch operation.
JsonPatchBuilder	add(String path, String value) Adds an "add" JSON Patch operation
JsonArray	apply(JsonArray target) A convenience method for build().apply(target)
JsonObject	apply(JsonObject target) A convenience method for build().apply(target)
JsonStructure	apply(JsonStructure target) A convenience method for new JsonPatch(build()).apply(target)
JsonArray	build() Returns the patch operations in a JsonArray
JsonPatchBuilder	copy(String path, String from) Adds a "copy" JSON Patch operation.
JsonPatchBuilder	move(String path, String from) Adds a "move" JSON Patch operation.
JsonPatchBuilder	remove(String path) Adds a "remove" JSON Patch operation.
JsonPatchBuilder	replace(String path, boolean value) Adds a "replace" JSON Patch operation.
JsonPatchBuilder	replace(String path, int value) Adds a "replace" JSON Patch operation.
JsonPatchBuilder	replace(String path, JsonValue value) Adds a "replace" JSON Patch operation.
JsonPatchBuilder	replace(String path, String value) Adds a "replace" JSON Patch operation.
JsonPatchBuilder	test(String path, boolean value) Adds a "test" JSON Patch operation.
JsonPatchBuilder	test(String path, int value) Adds a "test" JSON Patch operation.
JsonPatchBuilder	test(String path, JsonValue value) Adds a "test" JSON Patch operation.
JsonPatchBuilder	test(String path, String value) Adds a "test" JSON Patch operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

JsonPatchBuilder

public JsonPatchBuilder(JsonArray patch)

Creates a JsonPatchBuilder, starting with the specified JSON Patch

Parameters:

patch - the JSON Patch

JsonPatchBuilder

public JsonPatchBuilder()

Creates JsonPatchBuilder with empty JSON Patch

Method Detail

apply

public JsonStructure apply(JsonStructure target)

A convenience method for new JsonPatch(build()).apply(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 JsonObject apply(JsonObject target)

A convenience method for build().apply(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

See Also:

apply(JsonStructure)

apply

public JsonArray apply(JsonArray target)

A convenience method for build().apply(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

See Also:

apply(JsonStructure)

add

public JsonPatchBuilder add(String path,
                            JsonValue value)

Adds an "add" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

add

public JsonPatchBuilder add(String path,
                            String value)

Adds an "add" JSON Patch operation

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

add

public JsonPatchBuilder add(String path,
                            int value)

Adds an "add" JSON Patch operation

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

add

public JsonPatchBuilder add(String path,
                            boolean value)

Adds an "add" JSON Patch operation

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

remove

public JsonPatchBuilder remove(String path)

Adds a "remove" JSON Patch operation.

Parameters:

path - the "path" member of the operation

Returns:

this JsonPatch

replace

public JsonPatchBuilder replace(String path,
                                JsonValue value)

Adds a "replace" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

replace

public JsonPatchBuilder replace(String path,
                                String value)

Adds a "replace" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

replace

public JsonPatchBuilder replace(String path,
                                int value)

Adds a "replace" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

replace

public JsonPatchBuilder replace(String path,
                                boolean value)

Adds a "replace" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

move

public JsonPatchBuilder move(String path,
                             String from)

Adds a "move" JSON Patch operation.

Parameters:

path - the "path" member of the operation

from - the "from" member of the operation

Returns:

this JsonPatch

copy

public JsonPatchBuilder copy(String path,
                             String from)

Adds a "copy" JSON Patch operation.

Parameters:

path - the "path" member of the operation

from - the "from" member of the operation

Returns:

this JsonPatch

test

public JsonPatchBuilder test(String path,
                             JsonValue value)

Adds a "test" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

test

public JsonPatchBuilder test(String path,
                             String value)

Adds a "test" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

test

public JsonPatchBuilder test(String path,
                             int value)

Adds a "test" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

test

public JsonPatchBuilder test(String path,
                             boolean value)

Adds a "test" JSON Patch operation.

Parameters:

path - the "path" member of the operation

value - the "value" member of the operation

Returns:

this JsonPatch

build

public JsonArray build()

Returns the patch operations in a JsonArray

Returns:

the patch operations in a JsonArray