1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | /* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 2015-2017 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://oss.oracle.com/licenses/CDDL+GPL-1.1 * or LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. */ package org.glassfish.json; import javax.json.Json; import javax.json.JsonArray; import javax.json.JsonArrayBuilder; import javax.json.JsonException; import javax.json.JsonPatch; import javax.json.JsonPatch.Operation; import javax.json.JsonPatchBuilder; import javax.json.JsonStructure; import javax.json.JsonValue; /** * A builder for constructing a JSON Patch by adding * JSON Patch operations incrementally. * <p> * The following illustrates the approach. * <pre> * JsonPatchBuilder builder = Json.createPatchBuilder(); * JsonPatch patch = builder.add("/John/phones/office", "1234-567") * .remove("/Amy/age") * .build(); * </pre> * The result is equivalent to the following JSON Patch. * <pre> * [ * {"op" = "add", "path" = "/John/phones/office", "value" = "1234-567"}, * {"op" = "remove", "path" = "/Amy/age"} * ] </pre> * * @since 1.1 */ public final class JsonPatchBuilderImpl implements JsonPatchBuilder { private final JsonArrayBuilder builder; /** * Creates a JsonPatchBuilderImpl, starting with the specified * JSON Patch * @param patch the JSON Patch */ public JsonPatchBuilderImpl(JsonArray patch) { builder = Json.createArrayBuilder(patch); } /** * Creates JsonPatchBuilderImpl with empty JSON Patch */ public JsonPatchBuilderImpl() { builder = Json.createArrayBuilder(); } /** * A convenience method for {@code new JsonPatchImpl(build()).apply(target)}. * The target is not modified by the patch. * * @param <T> the target type, must be a subtype of {@link JsonStructure} * @param target the target to apply the patch operations * @return the transformed target after the patch * @throws JsonException if the supplied JSON Patch is malformed or if * it contains references to non-existing members */ public <T extends JsonStructure> T apply(T target) { return build().apply(target); } /** * Adds an "add" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder add(String path, JsonValue value) { builder.add(Json.createObjectBuilder() .add("op", Operation.ADD.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds an "add" JSON Patch operation * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder add(String path, String value) { builder.add(Json.createObjectBuilder() .add("op", Operation.ADD.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds an "add" JSON Patch operation * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder add(String path, int value) { builder.add(Json.createObjectBuilder() .add("op", Operation.ADD.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds an "add" JSON Patch operation * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder add(String path, boolean value) { builder.add(Json.createObjectBuilder() .add("op", Operation.ADD.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "remove" JSON Patch operation. * @param path the "path" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder remove(String path) { builder.add(Json.createObjectBuilder() .add("op", Operation.REMOVE.operationName()) .add("path", path) ); return this; } /** * Adds a "replace" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder replace(String path, JsonValue value) { builder.add(Json.createObjectBuilder() .add("op", Operation.REPLACE.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "replace" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder replace(String path, String value) { builder.add(Json.createObjectBuilder() .add("op", Operation.REPLACE.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "replace" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder replace(String path, int value) { builder.add(Json.createObjectBuilder() .add("op", Operation.REPLACE.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "replace" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder replace(String path, boolean value) { builder.add(Json.createObjectBuilder() .add("op", Operation.REPLACE.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "move" JSON Patch operation. * @param path the "path" member of the operation * @param from the "from" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder move(String path, String from) { builder.add(Json.createObjectBuilder() .add("op", Operation.MOVE.operationName()) .add("path", path) .add("from", from) ); return this; } /** * Adds a "copy" JSON Patch operation. * @param path the "path" member of the operation * @param from the "from" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder copy(String path, String from) { builder.add(Json.createObjectBuilder() .add("op", Operation.COPY.operationName()) .add("path", path) .add("from", from) ); return this; } /** * Adds a "test" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder test(String path, JsonValue value) { builder.add(Json.createObjectBuilder() .add("op", Operation.TEST.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "test" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder test(String path, String value) { builder.add(Json.createObjectBuilder() .add("op", Operation.TEST.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "test" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder test(String path, int value) { builder.add(Json.createObjectBuilder() .add("op", Operation.TEST.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Adds a "test" JSON Patch operation. * @param path the "path" member of the operation * @param value the "value" member of the operation * @return this JsonPatchBuilder */ @Override public JsonPatchBuilder test(String path, boolean value) { builder.add(Json.createObjectBuilder() .add("op", Operation.TEST.operationName()) .add("path", path) .add("value", value) ); return this; } /** * Returns the patch operations in a JsonArray * @return the patch operations in a JsonArray */ public JsonArray buildAsJsonArray() { return builder.build(); } /** * Returns the patch operation in a JsonPatch * @return the patch operation in a JsonPatch */ @Override public JsonPatch build() { return new JsonPatchImpl(buildAsJsonArray()); } } |