| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>jakarta.json</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="jakarta.json"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| </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 class="navBarCell1Rev">Package</li> |
| <li>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/jms/package-summary.html">Prev Package</a></li> |
| <li><a href="../../jakarta/json/bind/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <div class="header"> |
| <h1 title="Package" class="title">Package jakarta.json</h1> |
| <div class="docSummary"> |
| <div class="block">Provides an object model API to process <a href="http://json.org/">JSON</a>.</div> |
| </div> |
| <p>See: <a href="#package.description">Description</a></p> |
| </div> |
| <div class="contentContainer"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">A builder for creating <a href="../../jakarta/json/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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonBuilderFactory.html" title="interface in jakarta.json">JsonBuilderFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json"><code>JsonObjectBuilder</code></a> and <a href="../../jakarta/json/JsonArrayBuilder.html" title="interface in jakarta.json"><code>JsonArrayBuilder</code></a> |
| instances.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonMergePatch.html" title="interface in jakarta.json">JsonMergePatch</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonNumber.html" title="interface in jakarta.json">JsonNumber</a></td> |
| <td class="colLast"> |
| <div class="block">An immutable JSON number value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></td> |
| <td class="colLast"> |
| <div class="block">A builder for creating <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a> models from scratch.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonPatch.html" title="interface in jakarta.json">JsonPatch</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonPatchBuilder.html" title="interface in jakarta.json">JsonPatchBuilder</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonPointer.html" title="interface in jakarta.json">JsonPointer</a></td> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonReader.html" title="interface in jakarta.json">JsonReader</a></td> |
| <td class="colLast"> |
| <div class="block">Reads a JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or an <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> |
| structure from an input source.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonReaderFactory.html" title="interface in jakarta.json">JsonReaderFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="../../jakarta/json/JsonReader.html" title="interface in jakarta.json"><code>JsonReader</code></a> instances.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonString.html" title="interface in jakarta.json">JsonString</a></td> |
| <td class="colLast"> |
| <div class="block">An immutable JSON string value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></td> |
| <td class="colLast"> |
| <div class="block">Super type for the two structured types in JSON (<a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a>s |
| and <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a>s).</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a></td> |
| <td class="colLast"> |
| <div class="block"><code>JsonValue</code> represents an immutable JSON value.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a></td> |
| <td class="colLast"> |
| <div class="block">Writes a JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> structure |
| to an output source.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonWriterFactory.html" title="interface in jakarta.json">JsonWriterFactory</a></td> |
| <td class="colLast"> |
| <div class="block">Factory to create <a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json"><code>JsonWriter</code></a> instances.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/Json.html" title="class in jakarta.json">Json</a></td> |
| <td class="colLast"> |
| <div class="block">Factory class for creating JSON processing objects.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonConfig.html" title="class in jakarta.json">JsonConfig</a></td> |
| <td class="colLast"> |
| <div class="block">This class contains the Json properties and values.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonConfig.KeyStrategy.html" title="enum in jakarta.json">JsonConfig.KeyStrategy</a></td> |
| <td class="colLast"> |
| <div class="block">Contains the different values allowed for <a href="../../jakarta/json/JsonConfig.html#KEY_STRATEGY"><code>JsonConfig.KEY_STRATEGY</code></a>.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonPatch.Operation.html" title="enum in jakarta.json">JsonPatch.Operation</a></td> |
| <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="altColor"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonValue.ValueType.html" title="enum in jakarta.json">JsonValue.ValueType</a></td> |
| <td class="colLast"> |
| <div class="block">Indicates the type of a <a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json"><code>JsonValue</code></a> object.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| <li class="blockList"> |
| <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> |
| <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"> |
| <td class="colFirst"><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></td> |
| <td class="colLast"> |
| <div class="block"><code>JsonException</code> indicates that some exception happened during |
| JSON processing.</div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </li> |
| </ul> |
| <a name="package.description"> |
| <!-- --> |
| </a> |
| <h2 title="Package jakarta.json Description">Package jakarta.json Description</h2> |
| <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="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a> |
| and <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>JsonArray</code></a>. The interface <code>jakarta.json.JsonObject</code> provides |
| a <code>Map</code> view to access the unordered collection of zero or |
| more name/value pairs from the model. Similarly, the interface |
| <code>JsonArray</code> provides a <code>List</code> 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="../../jakarta/json/JsonObjectBuilder.html" title="interface in jakarta.json"><code>JsonObjectBuilder</code></a> and |
| <a href="../../jakarta/json/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="../../jakarta/json/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="../../jakarta/json/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> |
| </div> |
| <!-- ======= 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 class="navBarCell1Rev">Package</li> |
| <li>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/jms/package-summary.html">Prev Package</a></li> |
| <li><a href="../../jakarta/json/bind/package-summary.html">Next Package</a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/package-summary.html" target="_top">Frames</a></li> |
| <li><a href="package-summary.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> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
