source: josm/trunk/src/javax/json/JsonMergePatch.java@ 13611

Last change on this file since 13611 was 13231, checked in by Don-vip, 7 years ago

see #15682 - upgrade to JSR 374 (JSON Processing) API 1.1.2

File size: 3.7 KB
Line 
1/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright (c) 2015-2017 Oracle and/or its affiliates. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can
10 * obtain a copy of the License at
11 * https://oss.oracle.com/licenses/CDDL+GPL-1.1
12 * or LICENSE.txt. See the License for the specific
13 * language governing permissions and limitations under the License.
14 *
15 * When distributing the software, include this License Header Notice in each
16 * file and include the License file at LICENSE.txt.
17 *
18 * GPL Classpath Exception:
19 * Oracle designates this particular file as subject to the "Classpath"
20 * exception as provided by Oracle in the GPL Version 2 section of the License
21 * file that accompanied this code.
22 *
23 * Modifications:
24 * If applicable, add the following below the License Header, with the fields
25 * enclosed by brackets [] replaced by your own identifying information:
26 * "Portions Copyright [year] [name of copyright owner]"
27 *
28 * Contributor(s):
29 * If you wish your version of this file to be governed by only the CDDL or
30 * only the GPL Version 2, indicate your decision by adding "[Contributor]
31 * elects to include this software in this distribution under the [CDDL or GPL
32 * Version 2] license." If you don't indicate a single choice of license, a
33 * recipient has the option to distribute your version of this file under
34 * either the CDDL, the GPL Version 2 or to extend the choice of license to
35 * its licensees as provided above. However, if you add GPL Version 2 code
36 * and therefore, elected the GPL Version 2 license, then the option applies
37 * only if the new code is made subject to such option by the copyright
38 * holder.
39 */
40
41package javax.json;
42
43/**
44 * <p>This interface represents an implementation of a JSON Merge Patch
45 * as defined by <a href="http://tools.ietf.org/html/rfc7396">RFC 7396</a>.
46 * </p>
47 * <p>A {@code JsonMergePatch} can be instantiated with {@link Json#createMergePatch(JsonValue)}
48 * by specifying the patch operations in a JSON Merge Patch or using {@link Json#createMergeDiff(JsonValue, JsonValue)}
49 * to create a JSON Merge Patch based on the difference between two {@code JsonValue}s.
50 * </p>
51 * The following illustrates both approaches.
52 * <p>1. Construct a JsonMergePatch with an existing JSON Merge Patch.
53 * <pre>{@code
54 * JsonValue contacts = ... ; // The target to be patched
55 * JsonValue patch = ... ; // JSON Merge Patch
56 * JsonMergePatch mergePatch = Json.createMergePatch(patch);
57 * JsonValue result = mergePatch.apply(contacts);
58 * } </pre>
59 * 2. Construct a JsonMergePatch from a difference between two {@code JsonValue}s.
60 * <pre>{@code
61 * JsonValue source = ... ; // The source object
62 * JsonValue target = ... ; // The modified object
63 * JsonMergePatch mergePatch = Json.createMergeDiff(source, target); // The diff between source and target in a Json Merge Patch format
64 * } </pre>
65 *
66 * @see <a href="http://tools.ietf.org/html/rfc7396">RFC 7396</a>
67 *
68 * @since 1.1
69 */
70public interface JsonMergePatch {
71
72 /**
73 * Applies the JSON Merge Patch to the specified {@code target}.
74 * The target is not modified by the patch.
75 *
76 * @param target the target to apply the merge patch
77 * @return the transformed target after the patch
78 */
79 JsonValue apply(JsonValue target);
80
81 /**
82 * Returns the {@code JsonMergePatch} as {@code JsonValue}.
83 *
84 * @return this {@code JsonMergePatch} as {@code JsonValue}
85 */
86 JsonValue toJsonValue();
87}
Note: See TracBrowser for help on using the repository browser.