Package javax.json

Interface JsonPatchBuilder

public interface JsonPatchBuilder

TODO this is a final class in the spec, but that makes no sense. This class can be used to easily create JsonPatches. To get an instance use Json.createPatchBuilder() or Json.createPatchBuilder(JsonArray) The order of the operations corresponds to the order they are builded.

NOTICE: A JsonPatchBuilder contains state and therefore is NOT threadsafe and should not be used concurrently.

The following JsonPatch

     "[
         {
           "op": "add",
           "path": "/add/object",
           "value": {
             "foo": "bar"
           }
         },
         {
           "op": "remove",
           "path": "/remove/it"
         },
         {
           "op": "move",
           "path": "move/to",
           "from": "move/from"
         }
     ]"
 

can be build with the JsonPatchBuilder

     JsonPatch patch = Json.createJsonPatchBuilder()
                           .add("/add/object", Json.createObjectBuilder()
                                                   .add("foo", "bar")
                                                   .build())
                           .remove("/remove/it")
                           .move("/move/to", "move/from")
                           .build();

 

An instance of a JsonPatchBuilder can be reused for another JsonPatch after the build()-Method was called.

Method Summary

Modifier and Type	Method	Description
JsonPatchBuilder	add(String path, boolean value)
JsonPatchBuilder	add(String path, int value)
JsonPatchBuilder	add(String path, String value)
JsonPatchBuilder	add(String path, JsonValue value)	Adds an 'add'-operation to the JsonPatch
JsonPatch	build()
JsonPatchBuilder	copy(String path, String from)	Adds a 'copy'-operation to the JsonPatch
JsonPatchBuilder	move(String path, String from)	Adds a 'move'-operation to the JsonPatch
JsonPatchBuilder	remove(String path)	Adds a 'remove'-operation to the JsonPatch
JsonPatchBuilder	replace(String path, boolean value)
JsonPatchBuilder	replace(String path, int value)
JsonPatchBuilder	replace(String path, String value)
JsonPatchBuilder	replace(String path, JsonValue value)	Adds a 'replace'-operation to the JsonPatch
JsonPatchBuilder	test(String path, boolean value)
JsonPatchBuilder	test(String path, int value)
JsonPatchBuilder	test(String path, String value)
JsonPatchBuilder	test(String path, JsonValue value)	Adds a 'test'-operation to the JsonPointer

Method Details

add

JsonPatchBuilder add(String path,
 JsonValue value)

Adds an 'add'-operation to the JsonPatch

Parameters:

path - as JsonPointer where the value should be added

value - the value to add

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null

add

JsonPatchBuilder add(String path,
 String value)

See Also:

• add(String, JsonValue)

add

JsonPatchBuilder add(String path,
 int value)

See Also:

• add(String, JsonValue)

add

JsonPatchBuilder add(String path,
 boolean value)

See Also:

• add(String, JsonValue)

remove

JsonPatchBuilder remove(String path)

Adds a 'remove'-operation to the JsonPatch

Parameters:

path - as JsonPointer of the value which should get removed

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null

replace

JsonPatchBuilder replace(String path,
 JsonValue value)

Adds a 'replace'-operation to the JsonPatch

Parameters:

path - as JsonPointer to the value which should get replaced

value - the new value

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null

replace

JsonPatchBuilder replace(String path,
 String value)

See Also:

• replace(String, JsonValue)

replace

JsonPatchBuilder replace(String path,
 int value)

See Also:

• replace(String, JsonValue)

replace

JsonPatchBuilder replace(String path,
 boolean value)

See Also:

• replace(String, JsonValue)

move

JsonPatchBuilder move(String path,
 String from)

Adds a 'move'-operation to the JsonPatch

Parameters:

path - where the value should get inserted as JsonPointer

from - where the value should be taken from as JsonPointer

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null if the given from is null

copy

JsonPatchBuilder copy(String path,
 String from)

Adds a 'copy'-operation to the JsonPatch

Parameters:

path - where the copied value should get inserted as JsonPointer

from - value to copy as JsonPointer

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null if the given from is null

test

JsonPatchBuilder test(String path,
 JsonValue value)

Adds a 'test'-operation to the JsonPointer

Parameters:

path - as JsonPointer to the value to test

value - value to test

Returns:

the builder instance for chained method calls

Throws:

NullPointerException - if the given path is null

test

JsonPatchBuilder test(String path,
 String value)

See Also:

• test(String, JsonValue)

test

JsonPatchBuilder test(String path,
 int value)

See Also:

• test(String, JsonValue)

test

JsonPatchBuilder test(String path,
 boolean value)

See Also:

• test(String, JsonValue)

build

JsonPatch build()