| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonPatch</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonPatch"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/json/JsonPatch.Operation.html" title="enum in jakarta.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/JsonPatch.html" target="_top">Frames</a></li> |
| <li><a href="JsonPatch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">jakarta.json</div> |
| <h2 title="Interface JsonPatch" class="title">Interface JsonPatch</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonPatch</span></pre> |
| <div class="block"><p>This interface represents an immutable implementation of a JSON Patch |
| as defined by <a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>. |
| </p> |
| <p>A <code>JsonPatch</code> can be instantiated with <a href="../../jakarta/json/Json.html#createPatch-jakarta.json.JsonArray-"><code>Json.createPatch(JsonArray)</code></a> |
| by specifying the patch operations in a JSON Patch. Alternately, it |
| can also be constructed with a <a href="../../jakarta/json/JsonPatchBuilder.html" title="interface in jakarta.json"><code>JsonPatchBuilder</code></a>. |
| </p> |
| The following illustrates both approaches. |
| <p>1. Construct a JsonPatch with a JSON Patch. |
| <pre><code> |
| JsonArray contacts = ... // The target to be patched |
| JsonArray patch = ... ; // JSON Patch |
| JsonPatch jsonpatch = Json.createPatch(patch); |
| JsonArray result = jsonpatch.apply(contacts); |
| </code> </pre> |
| 2. Construct a JsonPatch with JsonPatchBuilder. |
| <pre><code> |
| JsonPatchBuilder builder = Json.createPatchBuilder(); |
| JsonArray result = builder.add("/John/phones/office", "1234-567") |
| .remove("/Amy/age") |
| .build() |
| .apply(contacts); |
| </code> </pre></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested.class.summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Interface and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonPatch.Operation.html" title="enum in jakarta.json">JsonPatch.Operation</a></span></code> |
| <div class="block">This enum represents the list of valid JSON Patch operations |
| as defined by <a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><T extends <a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>><br>T</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonPatch.html#apply-T-">apply</a></span>(T target)</code> |
| <div class="block">Applies the patch operations to the specified <code>target</code>.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonPatch.html#toJsonArray--">toJsonArray</a></span>()</code> |
| <div class="block">Returns the <code>JsonPatch</code> as <code>JsonArray</code>.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="apply-jakarta.json.JsonStructure-"> |
| <!-- --> |
| </a><a name="apply-T-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>apply</h4> |
| <pre><T extends <a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json">JsonStructure</a>> T apply(T target)</pre> |
| <div class="block">Applies the patch operations to the specified <code>target</code>. |
| The target is not modified by the patch.</div> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>T</code> - the target type, must be a subtype of <a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json"><code>JsonStructure</code></a></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>target</code> - the target to apply the patch operations</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the transformed target after the patch</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></code> - if the supplied JSON Patch is malformed or if |
| it contains references to non-existing members</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toJsonArray--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>toJsonArray</h4> |
| <pre><a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a> toJsonArray()</pre> |
| <div class="block">Returns the <code>JsonPatch</code> as <code>JsonArray</code>.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>this <code>JsonPatch</code> as <code>JsonArray</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../index-all.html">Index</a></li> |
| <li><a href="../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/json/JsonPatch.Operation.html" title="enum in jakarta.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/JsonPatch.html" target="_top">Frames</a></li> |
| <li><a href="JsonPatch.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested.class.summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
