| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonbAdapter</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="JsonbAdapter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":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"; |
| </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?jakarta/json/bind/adapter/JsonbAdapter.html" target="_top">Frames</a></li> |
| <li><a href="JsonbAdapter.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">jakarta.json.bind.adapter</div> |
| <h2 title="Interface JsonbAdapter" class="title">Interface JsonbAdapter<Original,Adapted></h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt><span class="paramLabel">Type Parameters:</span></dt> |
| <dd><code>Original</code> - The type that JSONB doesn't know how to handle</dd> |
| <dd><code>Adapted</code> - The type that JSONB knows how to handle out of the box |
| |
| <p>Adapter runtime "Original" and "Adapted" generic types are inferred from subclassing information, |
| which is mandatory for adapter to work.</p> |
| |
| <p>Sample 1:</p> |
| <pre> |
| <code> |
| // Generic information is provided by subclassing. |
| class BoxToCrateAdapter implements JsonbAdapter<Box<Integer>, Crate<String>> {...}; |
| jsonbConfig.withAdapters(new BoxToCrateAdapter()); |
| |
| // Generic information is provided by subclassing with anonymous class |
| jsonbConfig.withAdapters(new JsonbAdapter<Box<Integer>, Crate<String>> {...}); |
| </code> |
| </pre> |
| |
| <p>Sample 2:</p> |
| <pre> |
| <code> |
| BoxToCrateAdapter<T> implements JsonbAdapter<Box<T>, Integer> {...}; |
| |
| // Bad way: Generic type information is lost due to type erasure |
| jsonbConfig.withAdapters(new BoxToCrateAdapter<Integer>()); |
| |
| // Proper way: Anonymous class holds generic type information |
| jsonbConfig.withAdapters(new BoxToCrateAdapter<Integer>(){}); |
| </code> |
| </pre></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonbAdapter<Original,Adapted></span></pre> |
| <div class="block"><p>Allows to define custom mapping for given java type. The target type could be string or some |
| mappable java type.</p> |
| |
| <p>On serialization "Original" type is converted into "Adapted" type. After that "Adapted" type is serialized to |
| JSON the standard way.</p> |
| |
| <p>On deserialization it works the reverse way: JSON data are deserialized into "Adapted" type which is converted |
| to "Original" type after that.</p> |
| |
| <p>Adapters are registered using <a href="../../../../jakarta/json/bind/JsonbConfig.html#withAdapters-jakarta.json.bind.adapter.JsonbAdapter...-"><code>JsonbConfig.withAdapters(JsonbAdapter[])</code></a> method |
| or using <a href="../../../../jakarta/json/bind/annotation/JsonbTypeAdapter.html" title="annotation in jakarta.json.bind.annotation"><code>JsonbTypeAdapter</code></a> annotation on class field.</p></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="../../../../jakarta/json/bind/JsonbConfig.html" title="class in jakarta.json.bind"><code>JsonbConfig</code></a>, |
| <a href="../../../../jakarta/json/bind/annotation/JsonbTypeAdapter.html" title="annotation in jakarta.json.bind.annotation"><code>JsonbTypeAdapter</code></a></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="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="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Original</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html#adaptFromJson-Adapted-">adaptFromJson</a></span>(<a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Adapted</a> obj)</code> |
| <div class="block">This method is used on deserialization only.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Adapted</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html#adaptToJson-Original-">adaptToJson</a></span>(<a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Original</a> obj)</code> |
| <div class="block">This method is used on serialization only.</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="adaptToJson-java.lang.Object-"> |
| <!-- --> |
| </a><a name="adaptToJson-Original-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>adaptToJson</h4> |
| <pre><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Adapted</a> adaptToJson(<a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Original</a> obj) |
| throws java.lang.Exception</pre> |
| <div class="block">This method is used on serialization only. It contains a conversion logic from type Original to type Adapted. |
| After conversion Adapted type will be mapped to JSON the standard way.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - Object to convert or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Converted object which will be serialized to JSON or <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if there is an error during the conversion.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="adaptFromJson-java.lang.Object-"> |
| <!-- --> |
| </a><a name="adaptFromJson-Adapted-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>adaptFromJson</h4> |
| <pre><a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Original</a> adaptFromJson(<a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="type parameter in JsonbAdapter">Adapted</a> obj) |
| throws java.lang.Exception</pre> |
| <div class="block">This method is used on deserialization only. It contains a conversion logic from type Adapted to type Original.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>obj</code> - Object to convert or <code>null</code>.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Converted object representing pojo to be set into object graph or <code>null</code>.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code>java.lang.Exception</code> - if there is an error during the conversion.</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?jakarta/json/bind/adapter/JsonbAdapter.html" target="_top">Frames</a></li> |
| <li><a href="JsonbAdapter.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> |