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 | /* * 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 javax.json; /** * This interface represents an immutable implementation of a JSON Patch * as defined by * <a target=_blank href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>. * * <EMBED CLASS='external-html' DATA-FILE-ID=LICENSE DATA-CIETName=JsonPatch> * * <BR /><BR />A {@code JsonPatch} can be instantiated with {@link Json#createPatch(JsonArray)} * by specifying the patch operations in a JSON Patch. Alternately, it * can also be constructed with a {@link JsonPatchBuilder}. * * <BR /><BR />The following illustrates both approaches. * * <BR /><BR />1. Construct a JsonPatch with a JSON Patch. * * <BR /><DIV CLASS=SNIP>{@code * JsonArray contacts = ... // The target to be patched * JsonArray patch = ... ; // JSON Patch * JsonPatch jsonpatch = Json.createPatch(patch); * JsonArray result = jsonpatch.apply(contacts); * }</DIV> * * <BR /><BR />2. Construct a JsonPatch with JsonPatchBuilder. * * <BR /><DIV CLASS=SNIP>{@code * JsonPatchBuilder builder = Json.createPatchBuilder(); * * JsonArray result = builder * .add("/John/phones/office", "1234-567") * .remove("/Amy/age") * .build() * .apply(contacts); * }</DIV> * * @see <a target=_blank href="http://tools.ietf.org/html/rfc6902">RFC 6902</a> * * @since 1.1 */ public interface JsonPatch { /** * This enum represents the list of valid JSON Patch operations * as defined by * <a target=_blank href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>. * * @see <a target=_blank href="http://tools.ietf.org/html/rfc6902">RFC 6902</a> */ enum Operation { /** * "add" operation. */ ADD("add"), /** * "remove" operation. */ REMOVE("remove"), /** * "remove" operation. */ REPLACE("replace"), /** * "move" operation. */ MOVE("move"), /** * "copy" operation. */ COPY("copy"), /** * "test" operation. */ TEST("test"); private final String operationName; private Operation(String operationName) { this.operationName = operationName; } /** * Returns enum constant name as lower case string. * * @return lower case name of the enum constant */ public String operationName() { return operationName; } /** * Returns the enum constant with the specified name. * * @param operationName {@code operationName} to convert to the enum constant. * @return the enum constant for given {@code operationName} * @throws JsonException if given {@code operationName} is not recognized */ public static Operation fromOperationName(String operationName) { for (Operation op : values()) { if (op.operationName().equalsIgnoreCase(operationName)) { return op; } } throw new JsonException("Illegal value for the operationName of the JSON patch operation: " + operationName); } } /** * Applies the patch operations to the specified {@code 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 */ <T extends JsonStructure> T apply(T target); /** * Returns the {@code JsonPatch} as {@code JsonArray}. * * @return this {@code JsonPatch} as {@code JsonArray} */ JsonArray toJsonArray(); } |