blob: ac5e2295b1094c061c3072abae1ed8de227fd9b0 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>JsonObjectBuilder (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="JsonObjectBuilder (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":18,"i11":6,"i12":6,"i13":18};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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/JsonObjectBuilder.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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">&nbsp;</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>&nbsp;<a href="../../module-summary.html">jakarta.json</a></div>
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">jakarta.json</a></div>
<h2 title="Interface JsonObjectBuilder" class="title">Interface JsonObjectBuilder</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public interface <span class="typeNameLabel">JsonObjectBuilder</span></pre>
<div class="block">A builder for creating <a href="JsonObject.html" title="interface in jakarta.json"><code>JsonObject</code></a> models from scratch. This
interface initializes an empty JSON object model and provides methods to add
name/value pairs to the object model and to return the resulting object.
The methods in this class can be chained to add multiple name/value pairs
to the object.
<p>The class <a href="Json.html" title="class in jakarta.json"><code>Json</code></a> contains methods to create the builder
object. The example code below shows how to build an empty <code>JsonObject</code>
instance.
<pre>
<code>
JsonObject object = Json.createObjectBuilder().build();
</code>
</pre>
<p>The class <a href="JsonBuilderFactory.html" title="interface in jakarta.json"><code>JsonBuilderFactory</code></a> also contains methods to create
<code>JsonObjectBuilder</code> instances. A factory instance can be used to create
multiple builder instances with the same configuration. This the preferred
way to create multiple instances.
The example code below shows how to build a <code>JsonObject</code> model that
represents the following JSON object:
<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>
<p>The code to create the object shown above is the following:
<pre>
<code>
JsonBuilderFactory factory = Json.createBuilderFactory(config);
JsonObject value = factory.createObjectBuilder()
.add("firstName", "John")
.add("lastName", "Smith")
.add("age", 25)
.add("address", factory.createObjectBuilder()
.add("streetAddress", "21 2nd Street")
.add("city", "New York")
.add("state", "NY")
.add("postalCode", "10021"))
.add("phoneNumber", factory.createArrayBuilder()
.add(factory.createObjectBuilder()
.add("type", "home")
.add("number", "212 555-1234"))
.add(factory.createObjectBuilder()
.add("type", "fax")
.add("number", "646 555-4567")))
.build();
</code>
</pre>
<p>This class does <em>not</em> allow <code>null</code> to be used as a name or
value while building the JSON object</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonArrayBuilder.html" title="interface in jakarta.json"><code>JsonArrayBuilder</code></a></dd>
</dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd">&nbsp;</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><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,boolean)">add</a></span>&#8203;(<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>&nbsp;name,
boolean&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonValue#TRUE</code> or name/<code>JsonValue#FALSE</code> pair
to the JSON object associated with this object builder.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,double)">add</a></span>&#8203;(<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>&nbsp;name,
double&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,int)">add</a></span>&#8203;(<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>&nbsp;name,
int&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,long)">add</a></span>&#8203;(<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>&nbsp;name,
long&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,jakarta.json.JsonArrayBuilder)">add</a></span>&#8203;(<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>&nbsp;name,
<a href="JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>&nbsp;builder)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonArray</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,jakarta.json.JsonObjectBuilder)">add</a></span>&#8203;(<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>&nbsp;name,
<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;builder)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonObject</code> pair to the JSON object associated
with this object builder.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,jakarta.json.JsonValue)">add</a></span>&#8203;(<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>&nbsp;name,
<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonValue</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,java.lang.String)">add</a></span>&#8203;(<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>&nbsp;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>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonString</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,java.math.BigDecimal)">add</a></span>&#8203;(<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>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math" class="externalLink">BigDecimal</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#add(java.lang.String,java.math.BigInteger)">add</a></span>&#8203;(<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>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigInteger.html?is-external=true" title="class or interface in java.math" class="externalLink">BigInteger</a>&nbsp;value)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>default <a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addAll(jakarta.json.JsonObjectBuilder)">addAll</a></span>&#8203;(<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;builder)</code></th>
<td class="colLast">
<div class="block">Adds all name/value pairs in the JSON object associated with the specified
object builder to the JSON object associated with this object builder.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#addNull(java.lang.String)">addNull</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Adds a name/<code>JsonValue#NULL</code> pair to the JSON object associated
with this object builder where the value is <code>null</code>.</div>
</td>
</tr>
<tr id="i12" 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="#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the JSON object associated with this object builder.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>default <a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#remove(java.lang.String)">remove</a></span>&#8203;(<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>&nbsp;name)</code></th>
<td class="colLast">
<div class="block">Remove the name/value pair from the JSON object associated with this
object builder if it is present.</div>
</td>
</tr>
</table>
</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="add(java.lang.String,jakarta.json.JsonValue)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
<a href="JsonValue.html" title="interface in jakarta.json">JsonValue</a>&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonValue</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or value is null</dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;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>&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonString</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or value is null</dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,java.math.BigInteger)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigInteger.html?is-external=true" title="class or interface in java.math" class="externalLink">BigInteger</a>&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or value is null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a></dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,java.math.BigDecimal)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math" class="externalLink">BigDecimal</a>&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or value is null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a></dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
int&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 is null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a></dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
long&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 is null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a></dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,double)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
double&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonNumber</code> pair to the JSON object associated with
this object builder. If the object contains a mapping for the specified
name, this method replaces the old value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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/NumberFormatException.html?is-external=true" title="class or interface in java.lang" class="externalLink">NumberFormatException</a></code> - if the value is Not-a-Number (NaN) or
infinity</dd>
<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 is null</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="JsonNumber.html" title="interface in jakarta.json"><code>JsonNumber</code></a></dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
boolean&nbsp;value)</pre>
<div class="block">Adds a name/<code>JsonValue#TRUE</code> or name/<code>JsonValue#FALSE</code> pair
to the JSON object associated with this object builder. If the object
contains a mapping for the specified name, this method replaces the old
value with the specified value.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>value</code> - value in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 is null</dd>
</dl>
</li>
</ul>
<a id="addNull(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addNull</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;addNull&#8203;(<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>&nbsp;name)</pre>
<div class="block">Adds a name/<code>JsonValue#NULL</code> pair to the JSON object associated
with this object builder where the value is <code>null</code>.
If the object contains a mapping for the specified name, this method
replaces the old value with <code>null</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 is null</dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,jakarta.json.JsonObjectBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;builder)</pre>
<div class="block">Adds a name/<code>JsonObject</code> pair to the JSON object associated
with this object builder. The value <code>JsonObject</code> is built from the
specified object builder. If the object contains a mapping for the
specified name, this method replaces the old value with the
<code>JsonObject</code> from the specified object builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name in the name/value pair</dd>
<dd><code>builder</code> - the value is the object associated with this builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or builder is null</dd>
</dl>
</li>
</ul>
<a id="add(java.lang.String,jakarta.json.JsonArrayBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>add</h4>
<pre class="methodSignature"><a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;add&#8203;(<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>&nbsp;name,
<a href="JsonArrayBuilder.html" title="interface in jakarta.json">JsonArrayBuilder</a>&nbsp;builder)</pre>
<div class="block">Adds a name/<code>JsonArray</code> pair to the JSON object associated with
this object builder. The value <code>JsonArray</code> is built from the
specified array builder. If the object contains a mapping for the
specified name, this method replaces the old value with the
<code>JsonArray</code> from the specified array builder.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name in the name/value pair</dd>
<dd><code>builder</code> - the value is the object array with this builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 or builder is null</dd>
</dl>
</li>
</ul>
<a id="addAll(jakarta.json.JsonObjectBuilder)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addAll</h4>
<pre class="methodSignature">default&nbsp;<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;addAll&#8203;(<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;builder)</pre>
<div class="block">Adds all name/value pairs in the JSON object associated with the specified
object builder to the JSON object associated with this object builder.
The newly added name/value pair will replace any existing name/value pair with
the same name.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>builder</code> - the specified object builder</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 builder is null</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="remove(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>remove</h4>
<pre class="methodSignature">default&nbsp;<a href="JsonObjectBuilder.html" title="interface in jakarta.json">JsonObjectBuilder</a>&nbsp;remove&#8203;(<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>&nbsp;name)</pre>
<div class="block">Remove the name/value pair from the JSON object associated with this
object builder if it is present.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - the name in the name/value pair to be removed</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object builder</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 is null</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.1</dd>
</dl>
</li>
</ul>
<a id="build()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature"><a href="JsonObject.html" title="interface in jakarta.json">JsonObject</a>&nbsp;build()</pre>
<div class="block">Returns the JSON object associated with this object builder.
The iteration order for the <code>JsonObject</code> is based
on the order in which name/value pairs are added to the object using
this builder.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JSON object that is being built</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/JsonObjectBuilder.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&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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 &#169; 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>