| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonbDeserializer</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="JsonbDeserializer"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":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><a href="../../../../jakarta/json/bind/serializer/DeserializationContext.html" title="interface in jakarta.json.bind.serializer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/json/bind/serializer/JsonbSerializer.html" title="interface in jakarta.json.bind.serializer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/json/bind/serializer/JsonbDeserializer.html" target="_top">Frames</a></li> |
| <li><a href="JsonbDeserializer.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.serializer</div> |
| <h2 title="Interface JsonbDeserializer" class="title">Interface JsonbDeserializer<T></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>T</code> - Type to bind deserializer for.</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonbDeserializer<T></span></pre> |
| <div class="block"><p>Interface representing a custom deserializer for a given type. It provides a low-level API for java object |
| deserialization from JSON stream using <code>JsonParser</code>. Unlike <a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="interface in jakarta.json.bind.adapter"><code>JsonbAdapter</code></a>, |
| which acts more as converter from one java type to another, deserializer provides more fine grained control over |
| deserialization process.</p> |
| |
| <p><a href="../../../../jakarta/json/bind/serializer/DeserializationContext.html" title="interface in jakarta.json.bind.serializer"><code>DeserializationContext</code></a> acts as JSONB runtime, able to deserialize any java object provided.</p> |
| |
| <p>Sample of custom Deserializer:</p> |
| <pre> |
| class Box { |
| public BoxInner boxInnerObject; |
| public String name; |
| } |
| |
| BoxDeserializer implements JsonbDeserializer<Box> { |
| public Box deserialize(JsonParser parser, DeserializationContext ctx, Type rtType) { |
| Box = new Box(); |
| |
| while (parser.hasNext()) { |
| Event event = parser.next(); |
| |
| if (event == JsonParser.Event.KEY_NAME && parser.getString().equals("boxInnerObject") { |
| // Deserialize inner object |
| box.boxInnerObject = ctx.deserialize(BoxInner.class, jsonParser); |
| |
| } else if (event == JsonParser.Event.KEY_NAME && parser.getString().equals("name") { |
| // Deserialize name property |
| parser.next(); // move to VALUE |
| box.name = parser.getString(); |
| } |
| } |
| |
| return box; |
| } |
| } |
| </pre> |
| |
| <p>Deserializers are registered using <a href="../../../../jakarta/json/bind/JsonbConfig.html#withDeserializers-jakarta.json.bind.serializer.JsonbDeserializer...-"><code>JsonbConfig.withDeserializers(JsonbDeserializer[])</code></a> |
| method or using <a href="../../../../jakarta/json/bind/annotation/JsonbTypeDeserializer.html" title="annotation in jakarta.json.bind.annotation"><code>JsonbTypeDeserializer</code></a> annotation on type.</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/JsonbTypeDeserializer.html" title="annotation in jakarta.json.bind.annotation"><code>JsonbTypeDeserializer</code></a>, |
| <a href="../../../../jakarta/json/bind/serializer/JsonbSerializer.html" title="interface in jakarta.json.bind.serializer"><code>JsonbSerializer</code></a>, |
| <a href="../../../../jakarta/json/bind/adapter/JsonbAdapter.html" title="interface in jakarta.json.bind.adapter"><code>JsonbAdapter</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/serializer/JsonbDeserializer.html" title="type parameter in JsonbDeserializer">T</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../jakarta/json/bind/serializer/JsonbDeserializer.html#deserialize-JsonParser-jakarta.json.bind.serializer.DeserializationContext-java.lang.reflect.Type-">deserialize</a></span>(JsonParser parser, |
| <a href="../../../../jakarta/json/bind/serializer/DeserializationContext.html" title="interface in jakarta.json.bind.serializer">DeserializationContext</a> ctx, |
| java.lang.reflect.Type rtType)</code> |
| <div class="block">Deserialize JSON stream into object.</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="deserialize-JsonParser-jakarta.json.bind.serializer.DeserializationContext-java.lang.reflect.Type-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deserialize</h4> |
| <pre><a href="../../../../jakarta/json/bind/serializer/JsonbDeserializer.html" title="type parameter in JsonbDeserializer">T</a> deserialize(JsonParser parser, |
| <a href="../../../../jakarta/json/bind/serializer/DeserializationContext.html" title="interface in jakarta.json.bind.serializer">DeserializationContext</a> ctx, |
| java.lang.reflect.Type rtType)</pre> |
| <div class="block">Deserialize JSON stream into object.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>parser</code> - Json parser.</dd> |
| <dd><code>ctx</code> - Deserialization context.</dd> |
| <dd><code>rtType</code> - Type of returned object.</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>Deserialized 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="../../../../jakarta/json/bind/serializer/DeserializationContext.html" title="interface in jakarta.json.bind.serializer"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../jakarta/json/bind/serializer/JsonbSerializer.html" title="interface in jakarta.json.bind.serializer"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?jakarta/json/bind/serializer/JsonbDeserializer.html" target="_top">Frames</a></li> |
| <li><a href="JsonbDeserializer.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> |
