JsonPatchBuilder

public interface JsonPatchBuilder

A builder for constructing a JSON Patch as defined by RFC 6902 by adding JSON Patch operations incrementally.

The following illustrates the approach.

   JsonPatchBuilder builder = Json.createPatchBuilder();
   JsonPatch 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"}
 ]

Since:: 1.1
See Also:: RFC 6902

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`JsonPatchBuilder`	`add(java.lang.String path, boolean value)` Adds an "add" JSON Patch operation.
`JsonPatchBuilder`	`add(java.lang.String path, int value)` Adds an "add" JSON Patch operation.
`JsonPatchBuilder`	`add(java.lang.String path, JsonValue value)` Adds an "add" JSON Patch operation.
`JsonPatchBuilder`	`add(java.lang.String path, java.lang.String value)` Adds an "add" JSON Patch operation.
`JsonPatch`	`build()` Returns the JSON Patch.
`JsonPatchBuilder`	`copy(java.lang.String path, java.lang.String from)` Adds a "copy" JSON Patch operation.
`JsonPatchBuilder`	`move(java.lang.String path, java.lang.String from)` Adds a "move" JSON Patch operation.
`JsonPatchBuilder`	`remove(java.lang.String path)` Adds a "remove" JSON Patch operation.
`JsonPatchBuilder`	`replace(java.lang.String path, boolean value)` Adds a "replace" JSON Patch operation.
`JsonPatchBuilder`	`replace(java.lang.String path, int value)` Adds a "replace" JSON Patch operation.
`JsonPatchBuilder`	`replace(java.lang.String path, JsonValue value)` Adds a "replace" JSON Patch operation.
`JsonPatchBuilder`	`replace(java.lang.String path, java.lang.String value)` Adds a "replace" JSON Patch operation.
`JsonPatchBuilder`	`test(java.lang.String path, boolean value)` Adds a "test" JSON Patch operation.
`JsonPatchBuilder`	`test(java.lang.String path, int value)` Adds a "test" JSON Patch operation.
`JsonPatchBuilder`	`test(java.lang.String path, JsonValue value)` Adds a "test" JSON Patch operation.
`JsonPatchBuilder`	`test(java.lang.String path, java.lang.String value)` Adds a "test" JSON Patch operation.

- Method Detail
  - add
```
JsonPatchBuilder add(java.lang.String path,
                     JsonValue value)
```
    Adds an "add" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - add
```
JsonPatchBuilder add(java.lang.String path,
                     java.lang.String value)
```
    Adds an "add" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - add
```
JsonPatchBuilder add(java.lang.String path,
                     int value)
```
    Adds an "add" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - add
```
JsonPatchBuilder add(java.lang.String path,
                     boolean value)
```
    Adds an "add" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - remove
```
JsonPatchBuilder remove(java.lang.String path)
```
    Adds a "remove" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    Returns:
    
    this JsonPatchBuilder
  - replace
```
JsonPatchBuilder replace(java.lang.String path,
                         JsonValue value)
```
    Adds a "replace" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - replace
```
JsonPatchBuilder replace(java.lang.String path,
                         java.lang.String value)
```
    Adds a "replace" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - replace
```
JsonPatchBuilder replace(java.lang.String path,
                         int value)
```
    Adds a "replace" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - replace
```
JsonPatchBuilder replace(java.lang.String path,
                         boolean value)
```
    Adds a "replace" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - move
```
JsonPatchBuilder move(java.lang.String path,
                      java.lang.String from)
```
    Adds a "move" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    from - the "from" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - copy
```
JsonPatchBuilder copy(java.lang.String path,
                      java.lang.String from)
```
    Adds a "copy" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    from - the "from" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - test
```
JsonPatchBuilder test(java.lang.String path,
                      JsonValue value)
```
    Adds a "test" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - test
```
JsonPatchBuilder test(java.lang.String path,
                      java.lang.String value)
```
    Adds a "test" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - test
```
JsonPatchBuilder test(java.lang.String path,
                      int value)
```
    Adds a "test" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - test
```
JsonPatchBuilder test(java.lang.String path,
                      boolean value)
```
    Adds a "test" JSON Patch operation.
    
    Parameters:
    
    path - the "path" member of the operation. Must be a valid escaped JSON-Pointer string.
    
    value - the "value" member of the operation
    
    Returns:
    
    this JsonPatchBuilder
  - build
```
JsonPatch build()
```
    Returns the JSON Patch.
    
    Returns:
    
    a JSON Patch

Interface JsonPatchBuilder

Method Summary

Method Detail

add

add

add

add

remove

replace

replace

replace

replace

move

copy

test

test

test

test

build