| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonbBuilder</title> |
| <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonbBuilder"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":17,"i2":17,"i3":17,"i4":17,"i5":17,"i6":6,"i7":6}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static 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"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/json/bind/JsonbBuilder.html" target="_top">Frames</a></li> |
| <li><a href="JsonbBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">javax.json.bind</div> |
| <h2 title="Interface JsonbBuilder" class="title">Interface JsonbBuilder</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonbBuilder</span></pre> |
| <div class="block">JsonbBuilder class provides the client's entry point to the JSON Binding |
| API. It builds <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instances based on all |
| parameters and configuration provided before calling <code>build()</code> method. |
| |
| For most use-cases, only one instance of JsonbBuilder is required within the |
| application.</div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>JSON Binding 1.0</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a>, |
| <code>ServiceLoader</code></dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#build--">build</a></span>()</code> |
| <div class="block">Returns a new instance of <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> based on the |
| parameters and configuration specified previously in this builder.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#create--">create</a></span>()</code> |
| <div class="block">Create a new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance using the default |
| <code>JsonbBuilder</code> implementation provided as returned from |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#create-javax.json.bind.JsonbConfig-">create</a></span>(<a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind">JsonbConfig</a> config)</code> |
| <div class="block">Create a new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance using the default |
| <code>JsonbBuilder</code> implementation provided as returned from |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method, configured |
| with provided configuration.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#newBuilder--">newBuilder</a></span>()</code> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by the default |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#newBuilder-javax.json.bind.spi.JsonbProvider-">newBuilder</a></span>(<a href="../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a> provider)</code> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by |
| <code>provider#create</code> call.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#newBuilder-java.lang.String-">newBuilder</a></span>(java.lang.String providerName)</code> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider-java.lang.String-"><code>JsonbProvider.provider(String)</code></a> |
| method.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code><a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#withConfig-javax.json.bind.JsonbConfig-">withConfig</a></span>(<a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind">JsonbConfig</a> config)</code> |
| <div class="block">Set configuration which will be set to the newly created |
| <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</div> |
| </td> |
| </tr> |
| <tr id="i7" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../javax/json/bind/JsonbBuilder.html#withProvider-JsonProvider-">withProvider</a></span>(JsonProvider jsonpProvider)</code> |
| <div class="block">Provides a <a href="https://projects.eclipse.org/projects/ee4j.jsonp/">JSON-P</a> provider |
| to be used for all <a href="https://projects.eclipse.org/projects/ee4j.jsonp/">JSON-P</a> related operations.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="withConfig-javax.json.bind.JsonbConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withConfig</h4> |
| <pre><a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> withConfig(<a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind">JsonbConfig</a> config)</pre> |
| <div class="block">Set configuration which will be set to the newly created |
| <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - Configuration for <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <code>JsonbBuilder</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="withProvider-JsonProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>withProvider</h4> |
| <pre><a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> withProvider(JsonProvider jsonpProvider)</pre> |
| <div class="block">Provides a <a href="https://projects.eclipse.org/projects/ee4j.jsonp/">JSON-P</a> provider |
| to be used for all <a href="https://projects.eclipse.org/projects/ee4j.jsonp/">JSON-P</a> related operations.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jsonpProvider</code> - <code>JsonProvider</code> instance |
| to be used by Jsonb to lookup JSON-P implementation.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>This <code>JsonbBuilder</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="build--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>build</h4> |
| <pre><a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a> build()</pre> |
| <div class="block">Returns a new instance of <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> based on the |
| parameters and configuration specified previously in this builder.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Jsonb A new instance of <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> class. |
| Always a non-null valid object.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../javax/json/bind/JsonbException.html" title="class in javax.json.bind">JsonbException</a></code> - If an error was encountered while |
| creating the Jsonb instance, such as (but not limited to) no JSON |
| Binding provider found, or classes provide conflicting annotations.</dd> |
| <dd><code>java.lang.IllegalArgumentException</code> - If there's an error processing the set |
| parameters, such as the non-null parameter is assigned null value, or |
| unrecognized property is set in |
| <a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind"><code>JsonbConfig</code></a>.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>static <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a> create()</pre> |
| <div class="block">Create a new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance using the default |
| <code>JsonbBuilder</code> implementation provided as returned from |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create-javax.json.bind.JsonbConfig-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>static <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind">Jsonb</a> create(<a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind">JsonbConfig</a> config)</pre> |
| <div class="block">Create a new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance using the default |
| <code>JsonbBuilder</code> implementation provided as returned from |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method, configured |
| with provided configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>config</code> - Provided configuration for <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new <a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><code>Jsonb</code></a> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newBuilder--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBuilder</h4> |
| <pre>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> newBuilder()</pre> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by the default |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider--"><code>JsonbProvider.provider()</code></a> method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new <code>JsonbBuilder</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newBuilder-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>newBuilder</h4> |
| <pre>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> newBuilder(java.lang.String providerName)</pre> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by |
| <a href="../../../javax/json/bind/spi/JsonbProvider.html#provider-java.lang.String-"><code>JsonbProvider.provider(String)</code></a> |
| method.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>providerName</code> - Provider class name to be looked up by <code>ServiceLoader</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new <code>JsonbBuilder</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="newBuilder-javax.json.bind.spi.JsonbProvider-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newBuilder</h4> |
| <pre>static <a href="../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> newBuilder(<a href="../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a> provider)</pre> |
| <div class="block">Create a new <code>JsonbBuilder</code> instance as returned by |
| <code>provider#create</code> call.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>provider</code> - <code>JsonProvider</code> instance |
| used for creating <code>JsonBuilder instances</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>new <code>JsonbBuilder</code> instance.</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../index-all.html">Index</a></li> |
| <li><a href="../../../help-doc.html">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../javax/json/bind/Jsonb.html" title="interface in javax.json.bind"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../javax/json/bind/JsonbConfig.html" title="class in javax.json.bind"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?javax/json/bind/JsonbBuilder.html" target="_top">Frames</a></li> |
| <li><a href="JsonbBuilder.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
