Package javax.json

Interface JsonPatchBuilder


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

    This is a near-exact copy of the same-titled Java EE 8 Class: javax.json.JsonPatchBuilder
    Commenting has been slightly modified to accompany HiLiting the Code Examples.
    Java Source Code remains identical to the Sun-Oracle & 'GlassFish' Released Distributions.

    Read included License: HERE, and the CDDL+GPL-1.1
    All javax.json.* Code Obtained From: GitHub JavaEE jsonp  Public Archive.


    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 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