1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_10-ea) on Mon Apr 22 19:50:31 PDT 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>JsonDeserializer (jackson-databind 2.2.0 API)</title> 8<meta name="date" content="2013-04-22"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="JsonDeserializer (jackson-databind 2.2.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../overview-summary.html">Overview</a></li> 29<li><a href="package-summary.html">Package</a></li> 30<li class="navBarCell1Rev">Class</li> 31<li><a href="class-use/JsonDeserializer.html">Use</a></li> 32<li><a href="package-tree.html">Tree</a></li> 33<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 34<li><a href="../../../../index-all.html">Index</a></li> 35<li><a href="../../../../help-doc.html">Help</a></li> 36</ul> 37</div> 38<div class="subNav"> 39<ul class="navList"> 40<li><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonDeserializer.html" target="_top">Frames</a></li> 45<li><a href="JsonDeserializer.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li><a href="#nested_class_summary">Nested</a> | </li> 66<li>Field | </li> 67<li><a href="#constructor_summary">Constr</a> | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li>Field | </li> 73<li><a href="#constructor_detail">Constr</a> | </li> 74<li><a href="#method_detail">Method</a></li> 75</ul> 76</div> 77<a name="skip-navbar_top"> 78<!-- --> 79</a></div> 80<!-- ========= END OF TOP NAVBAR ========= --> 81<!-- ======== START OF CLASS DATA ======== --> 82<div class="header"> 83<div class="subTitle">com.fasterxml.jackson.databind</div> 84<h2 title="Class JsonDeserializer" class="title">Class JsonDeserializer<T></h2> 85</div> 86<div class="contentContainer"> 87<ul class="inheritance"> 88<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 89<li> 90<ul class="inheritance"> 91<li>com.fasterxml.jackson.databind.JsonDeserializer<T></li> 92</ul> 93</li> 94</ul> 95<div class="description"> 96<ul class="blockList"> 97<li class="blockList"> 98<dl> 99<dt>Direct Known Subclasses:</dt> 100<dd><a href="../../../../com/fasterxml/jackson/databind/deser/AbstractDeserializer.html" title="class in com.fasterxml.jackson.databind.deser">AbstractDeserializer</a>, <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer.None</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/std/StdDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.std">StdDeserializer</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/impl/TypeWrappedDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.impl">TypeWrappedDeserializer</a></dd> 101</dl> 102<hr> 103<br> 104<pre>public abstract class <span class="strong">JsonDeserializer<T></span> 105extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> 106<div class="block">Abstract class that defines API used by <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (and 107 other chained <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonDeserializer</code></a>s too) to deserialize Objects of 108 arbitrary types from JSON, using provided <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonParser</code></a>. 109<p> 110 Custom deserializers should usually not directly extend this class, 111 but instead extend <a href="../../../../com/fasterxml/jackson/databind/deser/std/StdDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.std"><code>StdDeserializer</code></a> 112 (or its subtypes like <a href="../../../../com/fasterxml/jackson/databind/deser/std/StdScalarDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.std"><code>StdScalarDeserializer</code></a>). 113<p> 114 If deserializer is an aggregate one -- meaning it delegates handling of some 115 of its contents by using other deserializer(s) -- it typically also needs 116 to implement <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a>, 117 which can locate dependant deserializers. This is important to allow dynamic 118 overrides of deserializers; separate call interface is needed to separate 119 resolution of dependant deserializers (which may have cyclic link back 120 to deserializer itself, directly or indirectly). 121<p> 122 In addition, to support per-property annotations (to configure aspects 123 of deserialization on per-property basis), deserializers may want 124 to implement 125 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a>, 126 which allows specialization of deserializers: call to 127 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html#createContextual(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.BeanProperty)"><code>ContextualDeserializer.createContextual(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.BeanProperty)</code></a> 128 is passed information on property, and can create a newly configured 129 deserializer for handling that particular property. 130<p> 131 If both 132 <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a> and 133 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a> 134 are implemented, resolution of deserializers occurs before 135 contextualization.</div> 136</li> 137</ul> 138</div> 139<div class="summary"> 140<ul class="blockList"> 141<li class="blockList"> 142<!-- ======== NESTED CLASS SUMMARY ======== --> 143<ul class="blockList"> 144<li class="blockList"><a name="nested_class_summary"> 145<!-- --> 146</a> 147<h3>Nested Class Summary</h3> 148<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 149<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 150<tr> 151<th class="colFirst" scope="col">Modifier and Type</th> 152<th class="colLast" scope="col">Class and Description</th> 153</tr> 154<tr class="altColor"> 155<td class="colFirst"><code>static class </code></td> 156<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer.None</a></strong></code> 157<div class="block">This marker class is only to be used with annotations, to 158 indicate that <b>no deserializer is configured</b>.</div> 159</td> 160</tr> 161</table> 162</li> 163</ul> 164<!-- ======== CONSTRUCTOR SUMMARY ======== --> 165<ul class="blockList"> 166<li class="blockList"><a name="constructor_summary"> 167<!-- --> 168</a> 169<h3>Constructor Summary</h3> 170<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 171<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 172<tr> 173<th class="colOne" scope="col">Constructor and Description</th> 174</tr> 175<tr class="altColor"> 176<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#JsonDeserializer()">JsonDeserializer</a></strong>()</code> </td> 177</tr> 178</table> 179</li> 180</ul> 181<!-- ========== METHOD SUMMARY =========== --> 182<ul class="blockList"> 183<li class="blockList"><a name="method_summary"> 184<!-- --> 185</a> 186<h3>Method Summary</h3> 187<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 188<caption><span>Methods</span><span class="tabEnd"> </span></caption> 189<tr> 190<th class="colFirst" scope="col">Modifier and Type</th> 191<th class="colLast" scope="col">Method and Description</th> 192</tr> 193<tr class="altColor"> 194<td class="colFirst"><code>abstract <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 195<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)">deserialize</a></strong>(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 196 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 197<div class="block">Method that can be called to ask implementation to deserialize 198 JSON content into the value type this serializer handles.</div> 199</td> 200</tr> 201<tr class="rowColor"> 202<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 203<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, T)">deserialize</a></strong>(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 204 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 205 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue)</code> 206<div class="block">Alternate deserialization method (compared to the most commonly 207 used, <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)"><code>deserialize(JsonParser, DeserializationContext)</code></a>), 208 which takes in initialized value instance, to be 209 configured and/or populated by deserializer.</div> 210</td> 211</tr> 212<tr class="altColor"> 213<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 214<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserializeWithType(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.jsontype.TypeDeserializer)">deserializeWithType</a></strong>(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 215 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 216 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer)</code> 217<div class="block">Deserialization called when type being deserialized is defined to 218 contain additional type identifier, to allow for correctly 219 instantiating correct subtype.</div> 220</td> 221</tr> 222<tr class="rowColor"> 223<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?></code></td> 224<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getDelegatee()">getDelegatee</a></strong>()</code> 225<div class="block">Accessor that can be used to determine if this deserializer uses 226 another deserializer for actual deserialization, by delegating 227 calls.</div> 228</td> 229</tr> 230<tr class="altColor"> 231<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 232<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyValue()">getEmptyValue</a></strong>()</code> 233<div class="block">Method called to determine value to be used for "empty" values 234 (most commonly when deserializing from empty JSON Strings).</div> 235</td> 236</tr> 237<tr class="rowColor"> 238<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> 239<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getKnownPropertyNames()">getKnownPropertyNames</a></strong>()</code> 240<div class="block">Method that will 241 either return null to indicate that type being deserializers 242 has no concept of properties; or a collection of identifiers 243 for which <code>toString</code> will give external property 244 name.</div> 245</td> 246</tr> 247<tr class="altColor"> 248<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 249<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue()">getNullValue</a></strong>()</code> 250<div class="block">Method that can be called to determine value to be used for 251 representing null values (values deserialized when JSON token 252 is <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonToken.html?is-external=true#VALUE_NULL" title="class or interface in com.fasterxml.jackson.core"><code>JsonToken.VALUE_NULL</code></a>).</div> 253</td> 254</tr> 255<tr class="rowColor"> 256<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/deser/impl/ObjectIdReader.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdReader</a></code></td> 257<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getObjectIdReader()">getObjectIdReader</a></strong>()</code> 258<div class="block">Accessor that can be used to check whether this deserializer 259 is expecting to possibly get an Object Identifier value instead of full value 260 serialization, and if so, should be able to resolve it to actual 261 Object instance to return as deserialized value.</div> 262</td> 263</tr> 264<tr class="altColor"> 265<td class="colFirst"><code>boolean</code></td> 266<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#isCachable()">isCachable</a></strong>()</code> 267<div class="block">Method called to see if deserializer instance is cachable and 268 usable for other properties of same type (type for which instance 269 was created).</div> 270</td> 271</tr> 272<tr class="rowColor"> 273<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?></code></td> 274<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#replaceDelegatee(com.fasterxml.jackson.databind.JsonDeserializer)">replaceDelegatee</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> delegatee)</code> 275<div class="block">Method that can be called to try to replace deserializer this deserializer 276 delegates calls to.</div> 277</td> 278</tr> 279<tr class="altColor"> 280<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><<a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a>></code></td> 281<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#unwrappingDeserializer(com.fasterxml.jackson.databind.util.NameTransformer)">unwrappingDeserializer</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/util/NameTransformer.html" title="class in com.fasterxml.jackson.databind.util">NameTransformer</a> unwrapper)</code> 282<div class="block">Method that will return deserializer instance that is able 283 to handle "unwrapped" value instances 284 If no unwrapped instance can be constructed, will simply 285 return this object as-is.</div> 286</td> 287</tr> 288</table> 289<ul class="blockList"> 290<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 291<!-- --> 292</a> 293<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 294<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> 295</ul> 296</li> 297</ul> 298</li> 299</ul> 300</div> 301<div class="details"> 302<ul class="blockList"> 303<li class="blockList"> 304<!-- ========= CONSTRUCTOR DETAIL ======== --> 305<ul class="blockList"> 306<li class="blockList"><a name="constructor_detail"> 307<!-- --> 308</a> 309<h3>Constructor Detail</h3> 310<a name="JsonDeserializer()"> 311<!-- --> 312</a> 313<ul class="blockListLast"> 314<li class="blockList"> 315<h4>JsonDeserializer</h4> 316<pre>public JsonDeserializer()</pre> 317</li> 318</ul> 319</li> 320</ul> 321<!-- ============ METHOD DETAIL ========== --> 322<ul class="blockList"> 323<li class="blockList"><a name="method_detail"> 324<!-- --> 325</a> 326<h3>Method Detail</h3> 327<a name="deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)"> 328<!-- --> 329</a> 330<ul class="blockList"> 331<li class="blockList"> 332<h4>deserialize</h4> 333<pre>public abstract <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> deserialize(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 334 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 335 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, 336 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></pre> 337<div class="block">Method that can be called to ask implementation to deserialize 338 JSON content into the value type this serializer handles. 339 Returned instance is to be constructed by method itself. 340<p> 341 Pre-condition for this method is that the parser points to the 342 first event that is part of value to deserializer (and which 343 is never JSON 'null' literal, more on this below): for simple 344 types it may be the only value; and for structured types the 345 Object start marker. 346 Post-condition is that the parser will point to the last 347 event that is part of deserialized value (or in case deserialization 348 fails, event that was not recognized or usable, which may be 349 the same event as the one it pointed to upon call). 350<p> 351 Note that this method is never called for JSON null literal, 352 and thus deserializers need (and should) not check for it.</div> 353<dl><dt><span class="strong">Parameters:</span></dt><dd><code>jp</code> - Parsed used for reading JSON content</dd><dd><code>ctxt</code> - Context that can be used to access information about 354 this deserialization activity.</dd> 355<dt><span class="strong">Returns:</span></dt><dd>Deserializer value</dd> 356<dt><span class="strong">Throws:</span></dt> 357<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 358<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></code></dd></dl> 359</li> 360</ul> 361<a name="deserialize(com.fasterxml.jackson.core.JsonParser,com.fasterxml.jackson.databind.DeserializationContext,java.lang.Object)"> 362<!-- --> 363</a><a name="deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, T)"> 364<!-- --> 365</a> 366<ul class="blockList"> 367<li class="blockList"> 368<h4>deserialize</h4> 369<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> deserialize(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 370 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 371 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue) 372 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, 373 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></pre> 374<div class="block">Alternate deserialization method (compared to the most commonly 375 used, <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext)"><code>deserialize(JsonParser, DeserializationContext)</code></a>), 376 which takes in initialized value instance, to be 377 configured and/or populated by deserializer. 378 Method is not necessarily used for all supported types; most commonly 379 it is used 380 for Collections and Maps. 381<p> 382 Default implementation just throws 383 <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>, to indicate that types 384 that do not explicitly add support do not necessarily support 385 update-existing-value operation (esp. immutable types)</div> 386<dl><dt><span class="strong">Throws:</span></dt> 387<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 388<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></code></dd></dl> 389</li> 390</ul> 391<a name="deserializeWithType(com.fasterxml.jackson.core.JsonParser, com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.jsontype.TypeDeserializer)"> 392<!-- --> 393</a> 394<ul class="blockList"> 395<li class="blockList"> 396<h4>deserializeWithType</h4> 397<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deserializeWithType(<a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> jp, 398 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 399 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer) 400 throws <a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, 401 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></pre> 402<div class="block">Deserialization called when type being deserialized is defined to 403 contain additional type identifier, to allow for correctly 404 instantiating correct subtype. This can be due to annotation on 405 type (or its supertype), or due to global settings without 406 annotations. 407<p> 408 Default implementation may work for some types, but ideally subclasses 409 should not rely on current default implementation. 410 Implementation is mostly provided to avoid compilation errors with older 411 code.</div> 412<dl><dt><span class="strong">Parameters:</span></dt><dd><code>typeDeserializer</code> - Deserializer to use for handling type information</dd> 413<dt><span class="strong">Throws:</span></dt> 414<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 415<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></code></dd></dl> 416</li> 417</ul> 418<a name="unwrappingDeserializer(com.fasterxml.jackson.databind.util.NameTransformer)"> 419<!-- --> 420</a> 421<ul class="blockList"> 422<li class="blockList"> 423<h4>unwrappingDeserializer</h4> 424<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><<a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a>> unwrappingDeserializer(<a href="../../../../com/fasterxml/jackson/databind/util/NameTransformer.html" title="class in com.fasterxml.jackson.databind.util">NameTransformer</a> unwrapper)</pre> 425<div class="block">Method that will return deserializer instance that is able 426 to handle "unwrapped" value instances 427 If no unwrapped instance can be constructed, will simply 428 return this object as-is. 429<p> 430 Default implementation just returns 'this' 431 indicating that no unwrapped variant exists</div> 432</li> 433</ul> 434<a name="replaceDelegatee(com.fasterxml.jackson.databind.JsonDeserializer)"> 435<!-- --> 436</a> 437<ul class="blockList"> 438<li class="blockList"> 439<h4>replaceDelegatee</h4> 440<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> replaceDelegatee(<a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> delegatee)</pre> 441<div class="block">Method that can be called to try to replace deserializer this deserializer 442 delegates calls to. If not supported (either this deserializer does not 443 delegate anything; or it does not want any changes), should either 444 throw <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> (if operation does not 445 make sense or is not allowed); or return this deserializer as is.</div> 446<dl><dt><span class="strong">Since:</span></dt> 447 <dd>2.1</dd></dl> 448</li> 449</ul> 450<a name="getNullValue()"> 451<!-- --> 452</a> 453<ul class="blockList"> 454<li class="blockList"> 455<h4>getNullValue</h4> 456<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> getNullValue()</pre> 457<div class="block">Method that can be called to determine value to be used for 458 representing null values (values deserialized when JSON token 459 is <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/JsonToken.html?is-external=true#VALUE_NULL" title="class or interface in com.fasterxml.jackson.core"><code>JsonToken.VALUE_NULL</code></a>). Usually this is simply 460 Java null, but for some types (especially primitives) it may be 461 necessary to use non-null values. 462<p> 463 Note that deserializers are allowed to call this just once and 464 then reuse returned value; that is, method is not guaranteed to 465 be called once for each conversion. 466<p> 467 Default implementation simply returns null.</div> 468</li> 469</ul> 470<a name="getEmptyValue()"> 471<!-- --> 472</a> 473<ul class="blockList"> 474<li class="blockList"> 475<h4>getEmptyValue</h4> 476<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> getEmptyValue()</pre> 477<div class="block">Method called to determine value to be used for "empty" values 478 (most commonly when deserializing from empty JSON Strings). 479 Usually this is same as <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue()"><code>getNullValue()</code></a> (which in turn 480 is usually simply Java null), but it can be overridden 481 for types. Or, if type should never be converted from empty 482 String, method can also throw an exception. 483<p> 484 Default implementation simple calls <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue()"><code>getNullValue()</code></a> and 485 returns value.</div> 486</li> 487</ul> 488<a name="getKnownPropertyNames()"> 489<!-- --> 490</a> 491<ul class="blockList"> 492<li class="blockList"> 493<h4>getKnownPropertyNames</h4> 494<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getKnownPropertyNames()</pre> 495<div class="block">Method that will 496 either return null to indicate that type being deserializers 497 has no concept of properties; or a collection of identifiers 498 for which <code>toString</code> will give external property 499 name. 500 This is only to be used for error reporting and diagnostics 501 purposes (most commonly, to accompany "unknown property" 502 exception).</div> 503<dl><dt><span class="strong">Since:</span></dt> 504 <dd>2.0</dd></dl> 505</li> 506</ul> 507<a name="isCachable()"> 508<!-- --> 509</a> 510<ul class="blockList"> 511<li class="blockList"> 512<h4>isCachable</h4> 513<pre>public boolean isCachable()</pre> 514<div class="block">Method called to see if deserializer instance is cachable and 515 usable for other properties of same type (type for which instance 516 was created). 517<p> 518 Note that cached instances are still resolved on per-property basis, 519 if instance implements <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a>: 520 cached instance is just as the base. This means that in most cases it is safe to 521 cache instances; however, it only makes sense to cache instances 522 if instantiation is expensive, or if instances are heavy-weight. 523<p> 524 Default implementation returns false, to indicate that no caching 525 is done.</div> 526</li> 527</ul> 528<a name="getObjectIdReader()"> 529<!-- --> 530</a> 531<ul class="blockList"> 532<li class="blockList"> 533<h4>getObjectIdReader</h4> 534<pre>public <a href="../../../../com/fasterxml/jackson/databind/deser/impl/ObjectIdReader.html" title="class in com.fasterxml.jackson.databind.deser.impl">ObjectIdReader</a> getObjectIdReader()</pre> 535<div class="block">Accessor that can be used to check whether this deserializer 536 is expecting to possibly get an Object Identifier value instead of full value 537 serialization, and if so, should be able to resolve it to actual 538 Object instance to return as deserialized value. 539<p> 540 Default implementation returns null, as support can not be implemented 541 generically. Some standard deserializers (most notably 542 <a href="../../../../com/fasterxml/jackson/databind/deser/BeanDeserializer.html" title="class in com.fasterxml.jackson.databind.deser"><code>BeanDeserializer</code></a>) 543 do implement this feature, and may return reader instance, depending on exact 544 configuration of instance (which is based on type, and referring property).</div> 545<dl><dt><span class="strong">Returns:</span></dt><dd>ObjectIdReader used for resolving possible Object Identifier 546 value, instead of full value serialization, if deserializer can do that; 547 null if no Object Id is expected.</dd><dt><span class="strong">Since:</span></dt> 548 <dd>2.0</dd></dl> 549</li> 550</ul> 551<a name="getDelegatee()"> 552<!-- --> 553</a> 554<ul class="blockListLast"> 555<li class="blockList"> 556<h4>getDelegatee</h4> 557<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> getDelegatee()</pre> 558<div class="block">Accessor that can be used to determine if this deserializer uses 559 another deserializer for actual deserialization, by delegating 560 calls. If so, will return immediate delegate (which itself may 561 delegate to further deserializers); otherwise will return null.</div> 562<dl><dt><span class="strong">Returns:</span></dt><dd>Deserializer this deserializer delegates calls to, if null; 563 null otherwise.</dd><dt><span class="strong">Since:</span></dt> 564 <dd>2.1</dd></dl> 565</li> 566</ul> 567</li> 568</ul> 569</li> 570</ul> 571</div> 572</div> 573<!-- ========= END OF CLASS DATA ========= --> 574<!-- ======= START OF BOTTOM NAVBAR ====== --> 575<div class="bottomNav"><a name="navbar_bottom"> 576<!-- --> 577</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 578<!-- --> 579</a> 580<ul class="navList" title="Navigation"> 581<li><a href="../../../../overview-summary.html">Overview</a></li> 582<li><a href="package-summary.html">Package</a></li> 583<li class="navBarCell1Rev">Class</li> 584<li><a href="class-use/JsonDeserializer.html">Use</a></li> 585<li><a href="package-tree.html">Tree</a></li> 586<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 587<li><a href="../../../../index-all.html">Index</a></li> 588<li><a href="../../../../help-doc.html">Help</a></li> 589</ul> 590</div> 591<div class="subNav"> 592<ul class="navList"> 593<li><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 594<li><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 595</ul> 596<ul class="navList"> 597<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonDeserializer.html" target="_top">Frames</a></li> 598<li><a href="JsonDeserializer.html" target="_top">No Frames</a></li> 599</ul> 600<ul class="navList" id="allclasses_navbar_bottom"> 601<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 602</ul> 603<div> 604<script type="text/javascript"><!-- 605 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 606 if(window==top) { 607 allClassesLink.style.display = "block"; 608 } 609 else { 610 allClassesLink.style.display = "none"; 611 } 612 //--> 613</script> 614</div> 615<div> 616<ul class="subNavList"> 617<li>Summary: </li> 618<li><a href="#nested_class_summary">Nested</a> | </li> 619<li>Field | </li> 620<li><a href="#constructor_summary">Constr</a> | </li> 621<li><a href="#method_summary">Method</a></li> 622</ul> 623<ul class="subNavList"> 624<li>Detail: </li> 625<li>Field | </li> 626<li><a href="#constructor_detail">Constr</a> | </li> 627<li><a href="#method_detail">Method</a></li> 628</ul> 629</div> 630<a name="skip-navbar_bottom"> 631<!-- --> 632</a></div> 633<!-- ======== END OF BOTTOM NAVBAR ======= --> 634<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 635</body> 636</html> 637