| <!DOCTYPE HTML> | |
| <!-- NewPage --> | |
| <html lang="en"> | |
| <head> | |
| <!-- Generated by javadoc --> | |
| <title>JsonObject (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="JsonObject (JSON Processing API documentation)"; | |
| } | |
| } | |
| catch(err) { | |
| } | |
| //--> | |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":6,"i8":6,"i9":6,"i10":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"; | |
| 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><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/JsonObject.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> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </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 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> | |
| <!-- ======== START OF CLASS DATA ======== --> | |
| <main role="main"> | |
| <div class="header"> | |
| <div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../module-summary.html">jakarta.json</a></div> | |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">jakarta.json</a></div> | |
| <h2 title="Interface JsonObject" class="title">Interface JsonObject</h2> | |
| </div> | |
| <div class="contentContainer"> | |
| <div class="description"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <dl> | |
| <dt>All Superinterfaces:</dt> | |
| <dd><code><a href="JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></code>, <code><a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a></code>, <code><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">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a>></code></dd> | |
| </dl> | |
| <hr> | |
| <pre>public interface <span class="typeNameLabel">JsonObject</span> | |
| extends <a href="JsonStructure.html" title="interface in jakarta.json">JsonStructure</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">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a>,​<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a>></pre> | |
| <div class="block"><code>JsonObject</code> class represents an immutable JSON object value | |
| (an unordered collection of zero or more name/value pairs). | |
| It also provides unmodifiable map view to the JSON object | |
| name/value mappings. | |
| <p>A JsonObject instance can be created from an input source using | |
| <a href="JsonReader.html#readObject()"><code>JsonReader.readObject()</code></a>. For example: | |
| <pre><code> | |
| JsonReader jsonReader = Json.createReader(...); | |
| JsonObject object = jsonReader.readObject(); | |
| jsonReader.close(); | |
| </code></pre> | |
| It can also be built from scratch using a <a href="JsonObjectBuilder.html" title="interface in jakarta.json"><code>JsonObjectBuilder</code></a>. | |
| <p>For example 1: An empty JSON object can be built as follows: | |
| <pre><code> | |
| JsonObject object = Json.createObjectBuilder().build(); | |
| </code></pre> | |
| For example 2: The following JSON | |
| <pre><code> | |
| { | |
| "firstName": "John", "lastName": "Smith", "age": 25, | |
| "address" : { | |
| "streetAddress": "21 2nd Street", | |
| "city": "New York", | |
| "state": "NY", | |
| "postalCode": "10021" | |
| }, | |
| "phoneNumber": [ | |
| { "type": "home", "number": "212 555-1234" }, | |
| { "type": "fax", "number": "646 555-4567" } | |
| ] | |
| } | |
| </code></pre> | |
| can be built using : | |
| <pre><code> | |
| JsonObject value = Json.createObjectBuilder() | |
| .add("firstName", "John") | |
| .add("lastName", "Smith") | |
| .add("age", 25) | |
| .add("address", Json.createObjectBuilder() | |
| .add("streetAddress", "21 2nd Street") | |
| .add("city", "New York") | |
| .add("state", "NY") | |
| .add("postalCode", "10021")) | |
| .add("phoneNumber", Json.createArrayBuilder() | |
| .add(Json.createObjectBuilder() | |
| .add("type", "home") | |
| .add("number", "212 555-1234")) | |
| .add(Json.createObjectBuilder() | |
| .add("type", "fax") | |
| .add("number", "646 555-4567"))) | |
| .build(); | |
| </code></pre> | |
| <code>JsonObject</code> can be written to JSON as follows: | |
| <pre><code> | |
| JsonWriter writer = ... | |
| JsonObject obj = ...; | |
| writer.writeObject(obj); | |
| </code></pre> | |
| <code>JsonObject</code> values can be <a href="JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a>, <a href="JsonArray.html" title="interface in jakarta.json"><code>JsonArray</code></a>, | |
| <a href="JsonString.html" title="interface in jakarta.json"><code>JsonString</code></a>, <a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a>, <a href="JsonValue.html#TRUE"><code>JsonValue.TRUE</code></a>, | |
| <a href="JsonValue.html#FALSE"><code>JsonValue.FALSE</code></a>, <a href="JsonValue.html#NULL"><code>JsonValue.NULL</code></a>. These values can be | |
| accessed using various accessor methods. | |
| <p>In the above example 2, "John" can be got using | |
| <pre><code> | |
| String firstName = object.getString("firstName"); | |
| </code></pre> | |
| This map object provides read-only access to the JSON object data, | |
| and attempts to modify the map, whether direct or via its collection | |
| views, result in an <code>UnsupportedOperationException</code>. | |
| <p>The map object's iteration ordering is based on the order in which | |
| name/value pairs are added to the corresponding builder or the order | |
| in which name/value pairs appear in the corresponding stream.</div> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="summary"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ======== NESTED CLASS SUMMARY ======== --> | |
| <section role="region"> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="nested.class.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested Class Summary</h3> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="nested.classes.inherited.from.class.jakarta.json.JsonValue"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested classes/interfaces inherited from interface jakarta.json.<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a></h3> | |
| <code><a href="JsonValue.ValueType.html" title="enum in jakarta.json">JsonValue.ValueType</a></code></li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="nested.classes.inherited.from.class.java.util.Map"> | |
| <!-- --> | |
| </a> | |
| <h3>Nested classes/interfaces inherited from interface java.util.<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">Map</a></h3> | |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">Map.Entry</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">K</a> extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>,​<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.Entry.html?is-external=true" title="class or interface in java.util" class="externalLink">V</a> extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html?is-external=true" title="class or interface in java.lang" class="externalLink">Object</a>></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </section> | |
| <!-- =========== FIELD SUMMARY =========== --> | |
| <section role="region"> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="field.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Field Summary</h3> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="fields.inherited.from.class.jakarta.json.JsonValue"> | |
| <!-- --> | |
| </a> | |
| <h3>Fields inherited from interface jakarta.json.<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a></h3> | |
| <code><a href="JsonValue.html#EMPTY_JSON_ARRAY">EMPTY_JSON_ARRAY</a>, <a href="JsonValue.html#EMPTY_JSON_OBJECT">EMPTY_JSON_OBJECT</a>, <a href="JsonValue.html#FALSE">FALSE</a>, <a href="JsonValue.html#NULL">NULL</a>, <a href="JsonValue.html#TRUE">TRUE</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </section> | |
| <!-- ========== METHOD SUMMARY =========== --> | |
| <section role="region"> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="method.summary"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Summary</h3> | |
| <table class="memberSummary"> | |
| <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="colSecond" scope="col">Method</th> | |
| <th class="colLast" scope="col">Description</th> | |
| </tr> | |
| <tr id="i0" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBoolean(java.lang.String)">getBoolean</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the boolean value of the associated mapping for the specified | |
| name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i1" class="rowColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getBoolean(java.lang.String,boolean)">getBoolean</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| boolean defaultValue)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the boolean value of the associated mapping for the specified | |
| name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i2" class="altColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInt(java.lang.String)">getInt</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">A convenience method for | |
| <code>getJsonNumber(name).intValue()</code></div> | |
| </td> | |
| </tr> | |
| <tr id="i3" class="rowColor"> | |
| <td class="colFirst"><code>int</code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInt(java.lang.String,int)">getInt</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| int defaultValue)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the int value of the associated <code>JsonNumber</code> mapping | |
| for the specified name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i4" class="altColor"> | |
| <td class="colFirst"><code><a href="JsonArray.html" title="interface in jakarta.json">JsonArray</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJsonArray(java.lang.String)">getJsonArray</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the array value to which the specified name is mapped.</div> | |
| </td> | |
| </tr> | |
| <tr id="i5" class="rowColor"> | |
| <td class="colFirst"><code><a href="JsonNumber.html" title="interface in jakarta.json">JsonNumber</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJsonNumber(java.lang.String)">getJsonNumber</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the number value to which the specified name is mapped.</div> | |
| </td> | |
| </tr> | |
| <tr id="i6" class="altColor"> | |
| <td class="colFirst"><code><a href="JsonObject.html" title="interface in jakarta.json">JsonObject</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJsonObject(java.lang.String)">getJsonObject</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the object value to which the specified name is mapped.</div> | |
| </td> | |
| </tr> | |
| <tr id="i7" class="rowColor"> | |
| <td class="colFirst"><code><a href="JsonString.html" title="interface in jakarta.json">JsonString</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getJsonString(java.lang.String)">getJsonString</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the string value to which the specified name is mapped.</div> | |
| </td> | |
| </tr> | |
| <tr id="i8" class="altColor"> | |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getString(java.lang.String)">getString</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">A convenience method for | |
| <code>getJsonString(name).getString()</code></div> | |
| </td> | |
| </tr> | |
| <tr id="i9" class="rowColor"> | |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a></code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getString(java.lang.String,java.lang.String)">getString</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> defaultValue)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns the string value of the associated <code>JsonString</code> mapping | |
| for the specified name.</div> | |
| </td> | |
| </tr> | |
| <tr id="i10" class="altColor"> | |
| <td class="colFirst"><code>boolean</code></td> | |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#isNull(java.lang.String)">isNull</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</code></th> | |
| <td class="colLast"> | |
| <div class="block">Returns <code>true</code> if the associated value for the specified name is | |
| <code>JsonValue.NULL</code>.</div> | |
| </td> | |
| </tr> | |
| </table> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="methods.inherited.from.class.jakarta.json.JsonStructure"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface jakarta.json.<a href="JsonStructure.html" title="interface in jakarta.json">JsonStructure</a></h3> | |
| <code><a href="JsonStructure.html#getValue(java.lang.String)">getValue</a></code></li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="methods.inherited.from.class.jakarta.json.JsonValue"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface jakarta.json.<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a></h3> | |
| <code><a href="JsonValue.html#asJsonArray()">asJsonArray</a>, <a href="JsonValue.html#asJsonObject()">asJsonObject</a>, <a href="JsonValue.html#getValueType()">getValueType</a>, <a href="JsonValue.html#toString()">toString</a></code></li> | |
| </ul> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="methods.inherited.from.class.java.util.Map"> | |
| <!-- --> | |
| </a> | |
| <h3>Methods inherited from interface java.util.<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">Map</a></h3> | |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#clear()" title="class or interface in java.util" class="externalLink">clear</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#compute(K,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">compute</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#computeIfAbsent(K,java.util.function.Function)" title="class or interface in java.util" class="externalLink">computeIfAbsent</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#computeIfPresent(K,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">computeIfPresent</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#containsKey(java.lang.Object)" title="class or interface in java.util" class="externalLink">containsKey</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#containsValue(java.lang.Object)" title="class or interface in java.util" class="externalLink">containsValue</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#entrySet()" title="class or interface in java.util" class="externalLink">entrySet</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.util" class="externalLink">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#forEach(java.util.function.BiConsumer)" title="class or interface in java.util" class="externalLink">forEach</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#get(java.lang.Object)" title="class or interface in java.util" class="externalLink">get</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#getOrDefault(java.lang.Object,V)" title="class or interface in java.util" class="externalLink">getOrDefault</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#hashCode()" title="class or interface in java.util" class="externalLink">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#isEmpty()" title="class or interface in java.util" class="externalLink">isEmpty</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#keySet()" title="class or interface in java.util" class="externalLink">keySet</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#merge(K,V,java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">merge</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#put(K,V)" title="class or interface in java.util" class="externalLink">put</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#putAll(java.util.Map)" title="class or interface in java.util" class="externalLink">putAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#putIfAbsent(K,V)" title="class or interface in java.util" class="externalLink">putIfAbsent</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#remove(java.lang.Object)" title="class or interface in java.util" class="externalLink">remove</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#remove(java.lang.Object,java.lang.Object)" title="class or interface in java.util" class="externalLink">remove</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#replace(K,V)" title="class or interface in java.util" class="externalLink">replace</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#replace(K,V,V)" title="class or interface in java.util" class="externalLink">replace</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#replaceAll(java.util.function.BiFunction)" title="class or interface in java.util" class="externalLink">replaceAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#size()" title="class or interface in java.util" class="externalLink">size</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html?is-external=true#values()" title="class or interface in java.util" class="externalLink">values</a></code></li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </section> | |
| </li> | |
| </ul> | |
| </div> | |
| <div class="details"> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <!-- ============ METHOD DETAIL ========== --> | |
| <section role="region"> | |
| <ul class="blockList"> | |
| <li class="blockList"><a id="method.detail"> | |
| <!-- --> | |
| </a> | |
| <h3>Method Detail</h3> | |
| <a id="getJsonArray(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJsonArray</h4> | |
| <pre class="methodSignature"><a href="JsonArray.html" title="interface in jakarta.json">JsonArray</a> getJsonArray​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns the array value to which the specified name is mapped. | |
| This is a convenience method for <code>(JsonArray)get(name)</code> to | |
| get the value.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - the name whose associated value is to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the array value to which the specified name is mapped, or | |
| <code>null</code> if this object contains no mapping for the name</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value to which the specified name | |
| is mapped is not assignable to JsonArray type</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getJsonObject(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJsonObject</h4> | |
| <pre class="methodSignature"><a href="JsonObject.html" title="interface in jakarta.json">JsonObject</a> getJsonObject​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns the object value to which the specified name is mapped. | |
| This is a convenience method for <code>(JsonObject)get(name)</code> to | |
| get the value.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - the name whose associated value is to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the object value to which the specified name is mapped, or | |
| <code>null</code> if this object contains no mapping for the name</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value to which the specified name | |
| is mapped is not assignable to JsonObject type</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getJsonNumber(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJsonNumber</h4> | |
| <pre class="methodSignature"><a href="JsonNumber.html" title="interface in jakarta.json">JsonNumber</a> getJsonNumber​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns the number value to which the specified name is mapped. | |
| This is a convenience method for <code>(JsonNumber)get(name)</code> to | |
| get the value.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - the name whose associated value is to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the number value to which the specified name is mapped, or | |
| <code>null</code> if this object contains no mapping for the name</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value to which the specified name | |
| is mapped is not assignable to JsonNumber type</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getJsonString(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getJsonString</h4> | |
| <pre class="methodSignature"><a href="JsonString.html" title="interface in jakarta.json">JsonString</a> getJsonString​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns the string value to which the specified name is mapped. | |
| This is a convenience method for <code>(JsonString)get(name)</code> to | |
| get the value.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - the name whose associated value is to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the string value to which the specified name is mapped, or | |
| <code>null</code> if this object contains no mapping for the name</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value to which the specified name | |
| is mapped is not assignable to JsonString type</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getString(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getString</h4> | |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getString​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">A convenience method for | |
| <code>getJsonString(name).getString()</code></div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as String</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the String value to which the specified name is mapped</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the specified name doesn't have any | |
| mapping</dd> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value for specified name mapping | |
| is not assignable to JsonString</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getString(java.lang.String,java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getString</h4> | |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> getString​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> defaultValue)</pre> | |
| <div class="block">Returns the string value of the associated <code>JsonString</code> mapping | |
| for the specified name. If <code>JsonString</code> is found, then its | |
| <a href="JsonString.html#getString()"><code>JsonString.getString()</code></a> is returned. Otherwise, | |
| the specified default value is returned.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as String</dd> | |
| <dd><code>defaultValue</code> - a default value to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the string value of the associated mapping for the name, | |
| or the default value</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getInt(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getInt</h4> | |
| <pre class="methodSignature">int getInt​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">A convenience method for | |
| <code>getJsonNumber(name).intValue()</code></div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as int</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the int value to which the specified name is mapped</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the specified name doesn't have any | |
| mapping</dd> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value for specified name mapping | |
| is not assignable to JsonNumber</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getInt(java.lang.String,int)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getInt</h4> | |
| <pre class="methodSignature">int getInt​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| int defaultValue)</pre> | |
| <div class="block">Returns the int value of the associated <code>JsonNumber</code> mapping | |
| for the specified name. If <code>JsonNumber</code> is found, then its | |
| <a href="JsonNumber.html#intValue()"><code>JsonNumber.intValue()</code></a> is returned. Otherwise, | |
| the specified default value is returned.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as int</dd> | |
| <dd><code>defaultValue</code> - a default value to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the int value of the associated mapping for the name, | |
| or the default value</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getBoolean(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getBoolean</h4> | |
| <pre class="methodSignature">boolean getBoolean​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns the boolean value of the associated mapping for the specified | |
| name. If the associated mapping is JsonValue.TRUE, then returns true. | |
| If the associated mapping is JsonValue.FALSE, then returns false.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as boolean</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the boolean value to which the specified name is mapped</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the specified name doesn't have any | |
| mapping</dd> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang" class="externalLink">ClassCastException</a></code> - if the value for specified name mapping | |
| is not assignable to JsonValue.TRUE or JsonValue.FALSE</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="getBoolean(java.lang.String,boolean)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockList"> | |
| <li class="blockList"> | |
| <h4>getBoolean</h4> | |
| <pre class="methodSignature">boolean getBoolean​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name, | |
| boolean defaultValue)</pre> | |
| <div class="block">Returns the boolean value of the associated mapping for the specified | |
| name. If the associated mapping is JsonValue.TRUE, then returns true. | |
| If the associated mapping is JsonValue.FALSE, then returns false. | |
| Otherwise, the specified default value is returned.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - whose associated value is to be returned as int</dd> | |
| <dd><code>defaultValue</code> - a default value to be returned</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>the boolean value of the associated mapping for the name, | |
| or the default value</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| <a id="isNull(java.lang.String)"> | |
| <!-- --> | |
| </a> | |
| <ul class="blockListLast"> | |
| <li class="blockList"> | |
| <h4>isNull</h4> | |
| <pre class="methodSignature">boolean isNull​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink">String</a> name)</pre> | |
| <div class="block">Returns <code>true</code> if the associated value for the specified name is | |
| <code>JsonValue.NULL</code>.</div> | |
| <dl> | |
| <dt><span class="paramLabel">Parameters:</span></dt> | |
| <dd><code>name</code> - name whose associated value is checked</dd> | |
| <dt><span class="returnLabel">Returns:</span></dt> | |
| <dd>return true if the associated value is <code>JsonValue.NULL</code>, | |
| otherwise false</dd> | |
| <dt><span class="throwsLabel">Throws:</span></dt> | |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NullPointerException</a></code> - if the specified name doesn't have any | |
| mapping</dd> | |
| </dl> | |
| </li> | |
| </ul> | |
| </li> | |
| </ul> | |
| </section> | |
| </li> | |
| </ul> | |
| </div> | |
| </div> | |
| </main> | |
| <!-- ========= END OF CLASS DATA ========= --> | |
| <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><a href="package-summary.html">Package</a></li> | |
| <li class="navBarCell1Rev">Class</li> | |
| <li><a href="class-use/JsonObject.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> | |
| <div> | |
| <ul class="subNavList"> | |
| <li>Summary: </li> | |
| <li><a href="#nested.class.summary">Nested</a> | </li> | |
| <li><a href="#field.summary">Field</a> | </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 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> |