| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonbProvider</title> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonbProvider"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":9,"i2":9}; |
| var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete 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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/json/bind/spi/JsonbProvider.html" target="_top">Frames</a></li> |
| <li><a href="JsonbProvider.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </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.spi</div> |
| <h2 title="Class JsonbProvider" class="title">Class JsonbProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>java.lang.Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>javax.json.bind.spi.JsonbProvider</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="typeNameLabel">JsonbProvider</span> |
| extends java.lang.Object</pre> |
| <div class="block">Service provider for JSON Binding implementations. |
| |
| Provider implementors must implement all abstract methods. |
| |
| API clients can obtain instance of default provider by calling: |
| <pre> |
| <code> |
| JsonbProvider provider = JsonbProvider.provider(); |
| </code>}</pre> |
| |
| Specific provider instance lookup: |
| <pre> |
| <code> |
| JsonbProvider provider; |
| try { |
| JsonbProvider.provider("foo.bar.ProviderImpl"); |
| } catch (JsonbException e) { |
| // provider not found or could not be instantiated |
| }</code></pre> |
| where '<code>foo.bar.ProviderImpl</code>' is a vendor implementation class extending |
| <a href="../../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi"><code>JsonbProvider</code></a> and identified to service loader as |
| specified in <code>ServiceLoader</code> documentation. |
| <br> |
| All the methods in this class are allowed to be called by multiple concurrent |
| threads.</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"> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/json/bind/spi/JsonbProvider.html#JsonbProvider--">JsonbProvider</a></span>()</code> |
| <div class="block">Protected constructor.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== 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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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>abstract <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/spi/JsonbProvider.html#create--">create</a></span>()</code> |
| <div class="block">Returns a new instance of <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a> class.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>static <a href="../../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/json/bind/spi/JsonbProvider.html#provider--">provider</a></span>()</code> |
| <div class="block">Creates a JSON Binding provider object by using the |
| <code>ServiceLoader.load(Class)</code> method.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../javax/json/bind/spi/JsonbProvider.html#provider-java.lang.String-">provider</a></span>(java.lang.String providerName)</code> |
| <div class="block">Creates a JSON Binding provider object by using the |
| <code>ServiceLoader.load(Class)</code> method, matching <code>providerName</code>.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.Object</h3> |
| <code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="JsonbProvider--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>JsonbProvider</h4> |
| <pre>protected JsonbProvider()</pre> |
| <div class="block">Protected constructor.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="provider--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>provider</h4> |
| <pre>public static <a href="../../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a> provider()</pre> |
| <div class="block">Creates a JSON Binding provider object by using the |
| <code>ServiceLoader.load(Class)</code> method. The first provider of |
| <code>JsonbProvider</code> class from list of providers returned by |
| <code>ServiceLoader.load</code> call is returned. If there are no available |
| service providers, this method tries to load the default service provider using |
| <code>Class.forName(String)</code> method.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>JsonbProvider</code> instance</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 there is no provider found, or there is a problem |
| instantiating the provider instance.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServiceLoader</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="provider-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>provider</h4> |
| <pre>public static <a href="../../../../javax/json/bind/spi/JsonbProvider.html" title="class in javax.json.bind.spi">JsonbProvider</a> provider(java.lang.String providerName)</pre> |
| <div class="block">Creates a JSON Binding provider object by using the |
| <code>ServiceLoader.load(Class)</code> method, matching <code>providerName</code>. |
| The first provider of <code>JsonbProvider</code> class from list of providers returned by |
| <code>ServiceLoader.load</code> call, matching providerName is returned. |
| If no such provider is found, JsonbException is thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>providerName</code> - Class name (<code>class.getName()</code>) to be chosen from the list of providers |
| returned by <code>ServiceLoader.load(JsonbProvider.class)</code> call.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd><code>JsonbProvider</code> instance</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 there is no provider found, or there is a problem |
| instantiating the provider instance.</dd> |
| <dd><code>java.lang.NullPointerException</code> - if providerName is <code>null</code>.</dd> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><code>ServiceLoader</code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="create--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>create</h4> |
| <pre>public abstract <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind">JsonbBuilder</a> create()</pre> |
| <div class="block">Returns a new instance of <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a> class. |
| |
| <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a> provides necessary getter |
| methods to access required parameters.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>JsonbBuilder |
| A new instance of class implementing <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a>. |
| 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 <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a> instance.</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>, |
| <a href="../../../../javax/json/bind/JsonbBuilder.html" title="interface in javax.json.bind"><code>JsonbBuilder</code></a></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>Prev Class</li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?javax/json/bind/spi/JsonbProvider.html" target="_top">Frames</a></li> |
| <li><a href="JsonbProvider.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><a href="#constructor.summary">Constr</a> | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |
