| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>jakarta.json (JSON Processing API documentation)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../jquery/jquery-3.3.1.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-migrate-3.0.1.js"></script> |
| <script type="text/javascript" src="../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="jakarta.json (JSON Processing API documentation)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var pathtoroot = "../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="../../module-summary.html">Module</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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 class="aboutLanguage"><br>JSON Processing API v2.0.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="moduleLabelInPackage">Module</span> <a href="../../module-summary.html">jakarta.json</a></div> |
| <h1 title="Package" class="title">Package jakarta.json</h1> |
| </div> |
| <div class="contentContainer"> |
| <section role="region"><a id="package.description"> |
| <!-- --> |
| </a> |
| <div class="block">Provides an object model API to process <a href="http://json.org/">JSON</a>. |
| |
| <p>The object model API is a high-level API that provides immutable object |
| models for JSON object and array structures. These JSON structures are |
| represented as object models using the Java types <a href="JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a> |
| and <a href="JsonArray.html" title="interface in jakarta.json"><code>JsonArray</code></a>. The interface <code>jakarta.json.JsonObject</code> provides |
| a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>Map</code></a> view to access the unordered collection of zero or |
| more name/value pairs from the model. Similarly, the interface |
| <code>JsonArray</code> provides a <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html?is-external=true" title="class or interface in java.util" class="externalLink"><code>List</code></a> view to access the |
| ordered sequence of zero or more values from the model. |
| |
| <p>The object model API uses builder patterns to create and modify |
| these object models. The classes <a href="JsonObjectBuilder.html" title="interface in jakarta.json"><code>JsonObjectBuilder</code></a> and |
| <a href="JsonArrayBuilder.html" title="interface in jakarta.json"><code>JsonArrayBuilder</code></a> provide methods to create and modify models |
| of type <code>JsonObject</code> and <code>JsonArray</code> respectively. |
| |
| <p>These object models can also be created from an input source using |
| the class <a href="JsonReader.html" title="interface in jakarta.json"><code>JsonReader</code></a>. Similarly, these object models |
| can be written to an output source using the class <a href="JsonWriter.html" title="interface in jakarta.json"><code>JsonWriter</code></a>. |
| <p> |
| This package includes several classes that implement other JSON related |
| standards: <a href="http://tools.ietf.org/html/rfc6901">JSON Pointer</a>, |
| <a Href="http://tools.ietf.org/html/rfc6902">JSON Patch</a>, and |
| <a Href="http://tools.ietf.org/html/rfc7396">JSON Merge Patch</a>. |
| They can be used to retrieve, transform or manipulate values in an |
| object model.</div> |
| </section> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Interface</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonArray.html" title="interface in jakarta.json">JsonArray</a></th> |
| <td class="colLast"> |
| <div class="block"><code>JsonArray</code> represents an immutable JSON array |
| (an ordered sequence of zero or more values).</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">A builder for creating <a href="JsonArray.html" title="interface in jakarta.json"><code>JsonArray</code></a> models from scratch, and for |
| modifying a existing <code>JsonArray</code>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonBuilderFactory.html" title="interface in jakarta.json">JsonBuilderFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="JsonObjectBuilder.html" title="interface in jakarta.json"><code>JsonObjectBuilder</code></a> and <a href="JsonArrayBuilder.html" title="interface in jakarta.json"><code>JsonArrayBuilder</code></a> |
| instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonMergePatch.html" title="interface in jakarta.json">JsonMergePatch</a></th> |
| <td class="colLast"> |
| <div class="block">This interface represents an implementation of a JSON Merge Patch |
| as defined by <a href="http://tools.ietf.org/html/rfc7396">RFC 7396</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonNumber.html" title="interface in jakarta.json">JsonNumber</a></th> |
| <td class="colLast"> |
| <div class="block">An immutable JSON number value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonObject.html" title="interface in jakarta.json">JsonObject</a></th> |
| <td class="colLast"> |
| <div class="block"><code>JsonObject</code> class represents an immutable JSON object value |
| (an unordered collection of zero or more name/value pairs).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">A builder for creating <a href="JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a> models from scratch.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonPatch.html" title="interface in jakarta.json">JsonPatch</a></th> |
| <td class="colLast"> |
| <div class="block">This interface represents an immutable implementation of a JSON Patch |
| as defined by <a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonPatchBuilder.html" title="interface in jakarta.json">JsonPatchBuilder</a></th> |
| <td class="colLast"> |
| <div class="block">A builder for constructing a JSON Patch as defined by |
| <a href="http://tools.ietf.org/html/rfc6902">RFC 6902</a> by adding |
| JSON Patch operations incrementally.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonPointer.html" title="interface in jakarta.json">JsonPointer</a></th> |
| <td class="colLast"> |
| <div class="block">This interface represents an immutable implementation of a JSON Pointer |
| as defined by <a href="http://tools.ietf.org/html/rfc6901">RFC 6901</a>.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonReader.html" title="interface in jakarta.json">JsonReader</a></th> |
| <td class="colLast"> |
| <div class="block">Reads a JSON <a href="JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or an <a href="JsonArray.html" title="interface in jakarta.json"><code>array</code></a> |
| structure from an input source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonReaderFactory.html" title="interface in jakarta.json">JsonReaderFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="JsonReader.html" title="interface in jakarta.json"><code>JsonReader</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonString.html" title="interface in jakarta.json">JsonString</a></th> |
| <td class="colLast"> |
| <div class="block">An immutable JSON string value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></th> |
| <td class="colLast"> |
| <div class="block">Super type for the two structured types in JSON (<a href="JsonObject.html" title="interface in jakarta.json"><code>object</code></a>s |
| and <a href="JsonArray.html" title="interface in jakarta.json"><code>array</code></a>s).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a></th> |
| <td class="colLast"> |
| <div class="block"><code>JsonValue</code> represents an immutable JSON value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonWriter.html" title="interface in jakarta.json">JsonWriter</a></th> |
| <td class="colLast"> |
| <div class="block">Writes a JSON <a href="JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or <a href="JsonArray.html" title="interface in jakarta.json"><code>array</code></a> structure |
| to an output source.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonWriterFactory.html" title="interface in jakarta.json">JsonWriterFactory</a></th> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="JsonWriter.html" title="interface in jakarta.json"><code>JsonWriter</code></a> instances.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Class</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="Json.html" title="class in jakarta.json">Json</a></th> |
| <td class="colLast"> |
| <div class="block">Factory class for creating JSON processing objects.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Enum</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonPatch.Operation.html" title="enum in jakarta.json">JsonPatch.Operation</a></th> |
| <td class="colLast"> |
| <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> |
| <tr class="rowColor"> |
| <th class="colFirst" scope="row"><a href="JsonValue.ValueType.html" title="enum in jakarta.json">JsonValue.ValueType</a></th> |
| <td class="colLast"> |
| <div class="block">Indicates the type of a <a href="JsonValue.html" title="interface in jakarta.json"><code>JsonValue</code></a> object.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary"> |
| <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Exception</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tbody> |
| <tr class="altColor"> |
| <th class="colFirst" scope="row"><a href="JsonException.html" title="class in jakarta.json">JsonException</a></th> |
| <td class="colLast"> |
| <div class="block"><code>JsonException</code> indicates that some exception happened during |
| JSON processing.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| </div> |
| </main> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../index.html">Overview</a></li> |
| <li><a href="../../module-summary.html">Module</a></li> |
| <li class="navBarCell1Rev">Package</li> |
| <li>Class</li> |
| <li><a href="package-use.html">Use</a></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 class="aboutLanguage"><br>JSON Processing API v2.0.0</div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses.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> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small>Comments to: <a href="mailto:jsonp-dev@eclipse.org">jsonp-dev@eclipse.org</a>.<br> Copyright © 2019, 2020 Eclipse Foundation. All rights reserved.<br> Use is subject to <a href="../../../doc-files/speclicense.html" target="_top">license terms</a>.</small></p> |
| </footer> |
| </body> |
| </html> |
