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 (1.8.0_162) on Tue Mar 24 11:44:35 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonDeserializer (jackson-databind 2.11.0.rc1 API)</title> 8<meta name="date" content="2020-03-24"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../../../../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="JsonDeserializer (jackson-databind 2.11.0.rc1 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":6,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":42,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]}; 24var altColor = "altColor"; 25var rowColor = "rowColor"; 26var tableTab = "tableTab"; 27var activeTableTab = "activeTableTab"; 28</script> 29<noscript> 30<div>JavaScript is disabled on your browser.</div> 31</noscript> 32<!-- ========= START OF TOP NAVBAR ======= --> 33<div class="topNav"><a name="navbar.top"> 34<!-- --> 35</a> 36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 37<a name="navbar.top.firstrow"> 38<!-- --> 39</a> 40<ul class="navList" title="Navigation"> 41<li><a href="../../../../overview-summary.html">Overview</a></li> 42<li><a href="package-summary.html">Package</a></li> 43<li class="navBarCell1Rev">Class</li> 44<li><a href="class-use/JsonDeserializer.html">Use</a></li> 45<li><a href="package-tree.html">Tree</a></li> 46<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 47<li><a href="../../../../index-all.html">Index</a></li> 48<li><a href="../../../../help-doc.html">Help</a></li> 49</ul> 50</div> 51<div class="subNav"> 52<ul class="navList"> 53<li><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonDeserializer.html" target="_top">Frames</a></li> 58<li><a href="JsonDeserializer.html" target="_top">No Frames</a></li> 59</ul> 60<ul class="navList" id="allclasses_navbar_top"> 61<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 62</ul> 63<div> 64<script type="text/javascript"><!-- 65 allClassesLink = document.getElementById("allclasses_navbar_top"); 66 if(window==top) { 67 allClassesLink.style.display = "block"; 68 } 69 else { 70 allClassesLink.style.display = "none"; 71 } 72 //--> 73</script> 74</div> 75<div> 76<ul class="subNavList"> 77<li>Summary: </li> 78<li><a href="#nested.class.summary">Nested</a> | </li> 79<li>Field | </li> 80<li><a href="#constructor.summary">Constr</a> | </li> 81<li><a href="#method.summary">Method</a></li> 82</ul> 83<ul class="subNavList"> 84<li>Detail: </li> 85<li>Field | </li> 86<li><a href="#constructor.detail">Constr</a> | </li> 87<li><a href="#method.detail">Method</a></li> 88</ul> 89</div> 90<a name="skip.navbar.top"> 91<!-- --> 92</a></div> 93<!-- ========= END OF TOP NAVBAR ========= --> 94<!-- ======== START OF CLASS DATA ======== --> 95<div class="header"> 96<div class="subTitle">com.fasterxml.jackson.databind</div> 97<h2 title="Class JsonDeserializer" class="title">Class JsonDeserializer<T></h2> 98</div> 99<div class="contentContainer"> 100<ul class="inheritance"> 101<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 102<li> 103<ul class="inheritance"> 104<li>com.fasterxml.jackson.databind.JsonDeserializer<T></li> 105</ul> 106</li> 107</ul> 108<div class="description"> 109<ul class="blockList"> 110<li class="blockList"> 111<dl> 112<dt>All Implemented Interfaces:</dt> 113<dd><a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html" title="interface in com.fasterxml.jackson.databind.deser">NullValueProvider</a></dd> 114</dl> 115<dl> 116<dt>Direct Known Subclasses:</dt> 117<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/deser/impl/ErrorThrowingDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.impl">ErrorThrowingDeserializer</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> 118</dl> 119<hr> 120<br> 121<pre>public abstract class <span class="typeNameLabel">JsonDeserializer<T></span> 122extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 123implements <a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html" title="interface in com.fasterxml.jackson.databind.deser">NullValueProvider</a></pre> 124<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 125 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 126 arbitrary types from JSON, using provided <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonParser</code></a>. 127<p> 128 Custom deserializers should usually not directly extend this class, 129 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> 130 (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>). 131<p> 132 If deserializer is an aggregate one -- meaning it delegates handling of some 133 of its contents by using other deserializer(s) -- it typically also needs 134 to implement <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a>, 135 which can locate dependant deserializers. This is important to allow dynamic 136 overrides of deserializers; separate call interface is needed to separate 137 resolution of dependant deserializers (which may have cyclic link back 138 to deserializer itself, directly or indirectly). 139<p> 140 In addition, to support per-property annotations (to configure aspects 141 of deserialization on per-property basis), deserializers may want 142 to implement 143 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a>, 144 which allows specialization of deserializers: call to 145 <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> 146 is passed information on property, and can create a newly configured 147 deserializer for handling that particular property. 148<p> 149 If both 150 <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a> and 151 <a href="../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ContextualDeserializer</code></a> 152 are implemented, resolution of deserializers occurs before 153 contextualization.</div> 154</li> 155</ul> 156</div> 157<div class="summary"> 158<ul class="blockList"> 159<li class="blockList"> 160<!-- ======== NESTED CLASS SUMMARY ======== --> 161<ul class="blockList"> 162<li class="blockList"><a name="nested.class.summary"> 163<!-- --> 164</a> 165<h3>Nested Class Summary</h3> 166<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 167<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 168<tr> 169<th class="colFirst" scope="col">Modifier and Type</th> 170<th class="colLast" scope="col">Class and Description</th> 171</tr> 172<tr class="altColor"> 173<td class="colFirst"><code>static class </code></td> 174<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer.None</a></span></code> 175<div class="block">This marker class is only to be used with annotations, to 176 indicate that <b>no deserializer is configured</b>.</div> 177</td> 178</tr> 179</table> 180</li> 181</ul> 182<!-- ======== CONSTRUCTOR SUMMARY ======== --> 183<ul class="blockList"> 184<li class="blockList"><a name="constructor.summary"> 185<!-- --> 186</a> 187<h3>Constructor Summary</h3> 188<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 189<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 190<tr> 191<th class="colOne" scope="col">Constructor and Description</th> 192</tr> 193<tr class="altColor"> 194<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#JsonDeserializer--">JsonDeserializer</a></span>()</code> </td> 195</tr> 196</table> 197</li> 198</ul> 199<!-- ========== METHOD SUMMARY =========== --> 200<ul class="blockList"> 201<li class="blockList"><a name="method.summary"> 202<!-- --> 203</a> 204<h3>Method Summary</h3> 205<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 206<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><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption> 207<tr> 208<th class="colFirst" scope="col">Modifier and Type</th> 209<th class="colLast" scope="col">Method and Description</th> 210</tr> 211<tr id="i0" class="altColor"> 212<td class="colFirst"><code>abstract <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 213<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-">deserialize</a></span>(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 214 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 215<div class="block">Method that can be called to ask implementation to deserialize 216 JSON content into the value type this serializer handles.</div> 217</td> 218</tr> 219<tr id="i1" class="rowColor"> 220<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 221<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#deserialize-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-T-">deserialize</a></span>(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 222 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 223 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue)</code> 224<div class="block">Alternate deserialization method (compared to the most commonly 225 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>), 226 which takes in initialized value instance, to be 227 configured and/or populated by deserializer.</div> 228</td> 229</tr> 230<tr id="i2" class="altColor"> 231<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 232<td class="colLast"><code><span class="memberNameLink"><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></span>(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 233 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 234 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer)</code> 235<div class="block">Deserialization called when type being deserialized is defined to 236 contain additional type identifier, to allow for correctly 237 instantiating correct subtype.</div> 238</td> 239</tr> 240<tr id="i3" class="rowColor"> 241<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 242<td class="colLast"><code><span class="memberNameLink"><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-T-">deserializeWithType</a></span>(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 243 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 244 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer, 245 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue)</code> 246<div class="block">Method similar to <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-"><code>deserializeWithType(JsonParser,DeserializationContext,TypeDeserializer)</code></a> 247 but called when merging value.</div> 248</td> 249</tr> 250<tr id="i4" class="altColor"> 251<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/deser/SettableBeanProperty.html" title="class in com.fasterxml.jackson.databind.deser">SettableBeanProperty</a></code></td> 252<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#findBackReference-java.lang.String-">findBackReference</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> refName)</code> 253<div class="block">Method needed by <a href="../../../../com/fasterxml/jackson/databind/deser/BeanDeserializerFactory.html" title="class in com.fasterxml.jackson.databind.deser"><code>BeanDeserializerFactory</code></a> to properly link 254 managed- and back-reference pairs.</div> 255</td> 256</tr> 257<tr id="i5" class="rowColor"> 258<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?></code></td> 259<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getDelegatee--">getDelegatee</a></span>()</code> 260<div class="block">Accessor that can be used to determine if this deserializer uses 261 another deserializer for actual deserialization, by delegating 262 calls.</div> 263</td> 264</tr> 265<tr id="i6" class="altColor"> 266<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a></code></td> 267<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyAccessPattern--">getEmptyAccessPattern</a></span>()</code> 268<div class="block">This method may be called in conjunction with calls to 269 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getEmptyValue(DeserializationContext)</code></a>, to check whether it needs 270 to be called just once (static values), or each time empty value is 271 needed.</div> 272</td> 273</tr> 274<tr id="i7" class="rowColor"> 275<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 276<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyValue--">getEmptyValue</a></span>()</code> 277<div class="block"><span class="deprecatedLabel">Deprecated.</span> 278<div class="block"><span class="deprecationComment">Since 2.6 Use overloaded variant that takes context argument</span></div> 279</div> 280</td> 281</tr> 282<tr id="i8" class="altColor"> 283<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 284<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyValue-com.fasterxml.jackson.databind.DeserializationContext-">getEmptyValue</a></span>(<a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 285<div class="block">Method called to determine value to be used for "empty" values 286 (most commonly when deserializing from empty JSON Strings).</div> 287</td> 288</tr> 289<tr id="i9" class="rowColor"> 290<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>></code></td> 291<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getKnownPropertyNames--">getKnownPropertyNames</a></span>()</code> 292<div class="block">Method that will 293 either return null to indicate that type being deserializers 294 has no concept of properties; or a collection of identifiers 295 for which <code>toString</code> will give external property 296 name.</div> 297</td> 298</tr> 299<tr id="i10" class="altColor"> 300<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a></code></td> 301<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullAccessPattern--">getNullAccessPattern</a></span>()</code> 302<div class="block">This method may be called in conjunction with calls to 303 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getNullValue(DeserializationContext)</code></a>, to check whether it needs 304 to be called just once (static values), or each time empty value is 305 needed.</div> 306</td> 307</tr> 308<tr id="i11" class="rowColor"> 309<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 310<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue--">getNullValue</a></span>()</code> 311<div class="block"><span class="deprecatedLabel">Deprecated.</span> 312<div class="block"><span class="deprecationComment">Since 2.6 Use overloaded variant that takes context argument</span></div> 313</div> 314</td> 315</tr> 316<tr id="i12" class="altColor"> 317<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a></code></td> 318<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-">getNullValue</a></span>(<a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 319<div class="block">Method that can be called to determine value to be used for 320 representing null values (values deserialized when JSON token 321 is <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/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> 322</td> 323</tr> 324<tr id="i13" class="rowColor"> 325<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> 326<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getObjectIdReader--">getObjectIdReader</a></span>()</code> 327<div class="block">Accessor that can be used to check whether this deserializer 328 is expecting to possibly get an Object Identifier value instead of full value 329 serialization, and if so, should be able to resolve it to actual 330 Object instance to return as deserialized value.</div> 331</td> 332</tr> 333<tr id="i14" class="altColor"> 334<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 335<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#handledType--">handledType</a></span>()</code> 336<div class="block">Method for accessing type of values this deserializer produces.</div> 337</td> 338</tr> 339<tr id="i15" class="rowColor"> 340<td class="colFirst"><code>boolean</code></td> 341<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#isCachable--">isCachable</a></span>()</code> 342<div class="block">Method called to see if deserializer instance is cachable and 343 usable for other properties of same type (type for which instance 344 was created).</div> 345</td> 346</tr> 347<tr id="i16" class="altColor"> 348<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?></code></td> 349<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#replaceDelegatee-com.fasterxml.jackson.databind.JsonDeserializer-">replaceDelegatee</a></span>(<a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> delegatee)</code> 350<div class="block">Method that can be called to try to replace deserializer this deserializer 351 delegates calls to.</div> 352</td> 353</tr> 354<tr id="i17" class="rowColor"> 355<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a></code></td> 356<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#supportsUpdate-com.fasterxml.jackson.databind.DeserializationConfig-">supportsUpdate</a></span>(<a href="../../../../com/fasterxml/jackson/databind/DeserializationConfig.html" title="class in com.fasterxml.jackson.databind">DeserializationConfig</a> config)</code> 357<div class="block">Introspection method that may be called to see whether deserializer supports 358 update of an existing value (aka "merging") or not.</div> 359</td> 360</tr> 361<tr id="i18" class="altColor"> 362<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> 363<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#unwrappingDeserializer-com.fasterxml.jackson.databind.util.NameTransformer-">unwrappingDeserializer</a></span>(<a href="../../../../com/fasterxml/jackson/databind/util/NameTransformer.html" title="class in com.fasterxml.jackson.databind.util">NameTransformer</a> unwrapper)</code> 364<div class="block">Method that will return deserializer instance that is able 365 to handle "unwrapped" value instances 366 If no unwrapped instance can be constructed, will simply 367 return this object as-is.</div> 368</td> 369</tr> 370</table> 371<ul class="blockList"> 372<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 373<!-- --> 374</a> 375<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 376<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> 377</ul> 378</li> 379</ul> 380</li> 381</ul> 382</div> 383<div class="details"> 384<ul class="blockList"> 385<li class="blockList"> 386<!-- ========= CONSTRUCTOR DETAIL ======== --> 387<ul class="blockList"> 388<li class="blockList"><a name="constructor.detail"> 389<!-- --> 390</a> 391<h3>Constructor Detail</h3> 392<a name="JsonDeserializer--"> 393<!-- --> 394</a> 395<ul class="blockListLast"> 396<li class="blockList"> 397<h4>JsonDeserializer</h4> 398<pre>public JsonDeserializer()</pre> 399</li> 400</ul> 401</li> 402</ul> 403<!-- ============ METHOD DETAIL ========== --> 404<ul class="blockList"> 405<li class="blockList"><a name="method.detail"> 406<!-- --> 407</a> 408<h3>Method Detail</h3> 409<a name="deserialize-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-"> 410<!-- --> 411</a> 412<ul class="blockList"> 413<li class="blockList"> 414<h4>deserialize</h4> 415<pre>public abstract <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> deserialize(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 416 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 417 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, 418 <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></pre> 419<div class="block">Method that can be called to ask implementation to deserialize 420 JSON content into the value type this serializer handles. 421 Returned instance is to be constructed by method itself. 422<p> 423 Pre-condition for this method is that the parser points to the 424 first event that is part of value to deserializer (and which 425 is never JSON 'null' literal, more on this below): for simple 426 types it may be the only value; and for structured types the 427 Object start marker or a FIELD_NAME. 428 </p> 429 <p> 430 The two possible input conditions for structured types result 431 from polymorphism via fields. In the ordinary case, Jackson 432 calls this method when it has encountered an OBJECT_START, 433 and the method implementation must advance to the next token to 434 see the first field name. If the application configures 435 polymorphism via a field, then the object looks like the following. 436 <pre> 437 { 438 "@class": "class name", 439 ... 440 } 441 </pre> 442 Jackson consumes the two tokens (the <tt>@class</tt> field name 443 and its value) in order to learn the class and select the deserializer. 444 Thus, the stream is pointing to the FIELD_NAME for the first field 445 after the @class. Thus, if you want your method to work correctly 446 both with and without polymorphism, you must begin your method with: 447 <pre> 448 if (p.currentToken() == JsonToken.START_OBJECT) { 449 p.nextToken(); 450 } 451 </pre> 452 This results in the stream pointing to the field name, so that 453 the two conditions align. 454 <p> 455 Post-condition is that the parser will point to the last 456 event that is part of deserialized value (or in case deserialization 457 fails, event that was not recognized or usable, which may be 458 the same event as the one it pointed to upon call). 459<p> 460 Note that this method is never called for JSON null literal, 461 and thus deserializers need (and should) not check for it.</div> 462<dl> 463<dt><span class="paramLabel">Parameters:</span></dt> 464<dd><code>p</code> - Parsed used for reading JSON content</dd> 465<dd><code>ctxt</code> - Context that can be used to access information about 466 this deserialization activity.</dd> 467<dt><span class="returnLabel">Returns:</span></dt> 468<dd>Deserialized value</dd> 469<dt><span class="throwsLabel">Throws:</span></dt> 470<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 471<dd><code><a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></code></dd> 472</dl> 473</li> 474</ul> 475<a name="deserialize-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-java.lang.Object-"> 476<!-- --> 477</a><a name="deserialize-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-T-"> 478<!-- --> 479</a> 480<ul class="blockList"> 481<li class="blockList"> 482<h4>deserialize</h4> 483<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> deserialize(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 484 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 485 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue) 486 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> 487<div class="block">Alternate deserialization method (compared to the most commonly 488 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>), 489 which takes in initialized value instance, to be 490 configured and/or populated by deserializer. 491 Method is not necessarily used (or supported) by all types 492 (it will not work for immutable types, for obvious reasons): 493 most commonly it is used for Collections and Maps. 494 It may be used both with "updating readers" (for POJOs) and 495 when Collections and Maps use "getter as setter". 496<p> 497 Default implementation just throws 498 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a>, to indicate that types 499 that do not explicitly add support do not necessarily support 500 update-existing-value operation (esp. immutable types)</div> 501<dl> 502<dt><span class="throwsLabel">Throws:</span></dt> 503<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 504</dl> 505</li> 506</ul> 507<a name="deserializeWithType-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.jsontype.TypeDeserializer-"> 508<!-- --> 509</a> 510<ul class="blockList"> 511<li class="blockList"> 512<h4>deserializeWithType</h4> 513<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deserializeWithType(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 514 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 515 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer) 516 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> 517<div class="block">Deserialization called when type being deserialized is defined to 518 contain additional type identifier, to allow for correctly 519 instantiating correct subtype. This can be due to annotation on 520 type (or its supertype), or due to global settings without 521 annotations. 522<p> 523 Default implementation may work for some types, but ideally subclasses 524 should not rely on current default implementation. 525 Implementation is mostly provided to avoid compilation errors with older 526 code.</div> 527<dl> 528<dt><span class="paramLabel">Parameters:</span></dt> 529<dd><code>typeDeserializer</code> - Deserializer to use for handling type information</dd> 530<dt><span class="throwsLabel">Throws:</span></dt> 531<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 532</dl> 533</li> 534</ul> 535<a name="deserializeWithType-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.jsontype.TypeDeserializer-java.lang.Object-"> 536<!-- --> 537</a><a name="deserializeWithType-com.fasterxml.jackson.core.JsonParser-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.jsontype.TypeDeserializer-T-"> 538<!-- --> 539</a> 540<ul class="blockList"> 541<li class="blockList"> 542<h4>deserializeWithType</h4> 543<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deserializeWithType(<a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonParser</a> p, 544 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 545 <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeDeserializer.html" title="class in com.fasterxml.jackson.databind.jsontype">TypeDeserializer</a> typeDeserializer, 546 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> intoValue) 547 throws <a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> 548<div class="block">Method similar to <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-"><code>deserializeWithType(JsonParser,DeserializationContext,TypeDeserializer)</code></a> 549 but called when merging value. Considered "bad merge" by default implementation, 550 but if <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_MERGE_FOR_UNMERGEABLE"><code>MapperFeature.IGNORE_MERGE_FOR_UNMERGEABLE</code></a> is enabled will simple delegate to 551 <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-"><code>deserializeWithType(JsonParser, DeserializationContext, TypeDeserializer)</code></a>.</div> 552<dl> 553<dt><span class="throwsLabel">Throws:</span></dt> 554<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 555<dt><span class="simpleTagLabel">Since:</span></dt> 556<dd>2.10</dd> 557</dl> 558</li> 559</ul> 560<a name="unwrappingDeserializer-com.fasterxml.jackson.databind.util.NameTransformer-"> 561<!-- --> 562</a> 563<ul class="blockList"> 564<li class="blockList"> 565<h4>unwrappingDeserializer</h4> 566<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> 567<div class="block">Method that will return deserializer instance that is able 568 to handle "unwrapped" value instances 569 If no unwrapped instance can be constructed, will simply 570 return this object as-is. 571<p> 572 Default implementation just returns 'this' 573 indicating that no unwrapped variant exists</div> 574</li> 575</ul> 576<a name="replaceDelegatee-com.fasterxml.jackson.databind.JsonDeserializer-"> 577<!-- --> 578</a> 579<ul class="blockList"> 580<li class="blockList"> 581<h4>replaceDelegatee</h4> 582<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> 583<div class="block">Method that can be called to try to replace deserializer this deserializer 584 delegates calls to. If not supported (either this deserializer does not 585 delegate anything; or it does not want any changes), should either 586 throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</code></a> (if operation does not 587 make sense or is not allowed); or return this deserializer as is.</div> 588<dl> 589<dt><span class="simpleTagLabel">Since:</span></dt> 590<dd>2.1</dd> 591</dl> 592</li> 593</ul> 594<a name="handledType--"> 595<!-- --> 596</a> 597<ul class="blockList"> 598<li class="blockList"> 599<h4>handledType</h4> 600<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> handledType()</pre> 601<div class="block">Method for accessing type of values this deserializer produces. 602 Note that this information is not guaranteed to be exact -- it 603 may be a more generic (super-type) -- but it should not be 604 incorrect (return a non-related type). 605<p> 606 Default implementation will return null, which means almost same 607 same as returning <code>Object.class</code> would; that is, that 608 nothing is known about handled type. 609<p></div> 610<dl> 611<dt><span class="simpleTagLabel">Since:</span></dt> 612<dd>2.3</dd> 613</dl> 614</li> 615</ul> 616<a name="isCachable--"> 617<!-- --> 618</a> 619<ul class="blockList"> 620<li class="blockList"> 621<h4>isCachable</h4> 622<pre>public boolean isCachable()</pre> 623<div class="block">Method called to see if deserializer instance is cachable and 624 usable for other properties of same type (type for which instance 625 was created). 626<p> 627 Note that cached instances are still resolved on per-property basis, 628 if instance implements <a href="../../../../com/fasterxml/jackson/databind/deser/ResolvableDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><code>ResolvableDeserializer</code></a>: 629 cached instance is just as the base. This means that in most cases it is safe to 630 cache instances; however, it only makes sense to cache instances 631 if instantiation is expensive, or if instances are heavy-weight. 632<p> 633 Default implementation returns false, to indicate that no caching 634 is done.</div> 635</li> 636</ul> 637<a name="getDelegatee--"> 638<!-- --> 639</a> 640<ul class="blockList"> 641<li class="blockList"> 642<h4>getDelegatee</h4> 643<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><?> getDelegatee()</pre> 644<div class="block">Accessor that can be used to determine if this deserializer uses 645 another deserializer for actual deserialization, by delegating 646 calls. If so, will return immediate delegate (which itself may 647 delegate to further deserializers); otherwise will return null.</div> 648<dl> 649<dt><span class="returnLabel">Returns:</span></dt> 650<dd>Deserializer this deserializer delegates calls to, if null; 651 null otherwise.</dd> 652<dt><span class="simpleTagLabel">Since:</span></dt> 653<dd>2.1</dd> 654</dl> 655</li> 656</ul> 657<a name="getKnownPropertyNames--"> 658<!-- --> 659</a> 660<ul class="blockList"> 661<li class="blockList"> 662<h4>getKnownPropertyNames</h4> 663<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>> getKnownPropertyNames()</pre> 664<div class="block">Method that will 665 either return null to indicate that type being deserializers 666 has no concept of properties; or a collection of identifiers 667 for which <code>toString</code> will give external property 668 name. 669 This is only to be used for error reporting and diagnostics 670 purposes (most commonly, to accompany "unknown property" 671 exception).</div> 672<dl> 673<dt><span class="simpleTagLabel">Since:</span></dt> 674<dd>2.0</dd> 675</dl> 676</li> 677</ul> 678<a name="getNullValue-com.fasterxml.jackson.databind.DeserializationContext-"> 679<!-- --> 680</a> 681<ul class="blockList"> 682<li class="blockList"> 683<h4>getNullValue</h4> 684<pre>public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> getNullValue(<a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 685 throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 686<div class="block">Method that can be called to determine value to be used for 687 representing null values (values deserialized when JSON token 688 is <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/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 689 Java null, but for some types (especially primitives) it may be 690 necessary to use non-null values. 691<p> 692 This method may be called once, or multiple times, depending on what 693 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullAccessPattern--"><code>getNullAccessPattern()</code></a> returns. 694<p> 695 Default implementation simply returns null.</div> 696<dl> 697<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 698<dd><code><a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-">getNullValue</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html" title="interface in com.fasterxml.jackson.databind.deser">NullValueProvider</a></code></dd> 699<dt><span class="throwsLabel">Throws:</span></dt> 700<dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> 701<dt><span class="simpleTagLabel">Since:</span></dt> 702<dd>2.6 Added to replace earlier no-arguments variant</dd> 703</dl> 704</li> 705</ul> 706<a name="getNullAccessPattern--"> 707<!-- --> 708</a> 709<ul class="blockList"> 710<li class="blockList"> 711<h4>getNullAccessPattern</h4> 712<pre>public <a href="../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a> getNullAccessPattern()</pre> 713<div class="block">This method may be called in conjunction with calls to 714 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getNullValue(DeserializationContext)</code></a>, to check whether it needs 715 to be called just once (static values), or each time empty value is 716 needed. 717<p> 718 Default implementation indicates that "null value" to use for input null 719 is simply Java `null` for all deserializers, unless overridden by sub-classes. 720 This information may be used as optimization.</div> 721<dl> 722<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 723<dd><code><a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html#getNullAccessPattern--">getNullAccessPattern</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/deser/NullValueProvider.html" title="interface in com.fasterxml.jackson.databind.deser">NullValueProvider</a></code></dd> 724</dl> 725</li> 726</ul> 727<a name="getEmptyAccessPattern--"> 728<!-- --> 729</a> 730<ul class="blockList"> 731<li class="blockList"> 732<h4>getEmptyAccessPattern</h4> 733<pre>public <a href="../../../../com/fasterxml/jackson/databind/util/AccessPattern.html" title="enum in com.fasterxml.jackson.databind.util">AccessPattern</a> getEmptyAccessPattern()</pre> 734<div class="block">This method may be called in conjunction with calls to 735 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getEmptyValue(DeserializationContext)</code></a>, to check whether it needs 736 to be called just once (static values), or each time empty value is 737 needed.</div> 738<dl> 739<dt><span class="simpleTagLabel">Since:</span></dt> 740<dd>2.9</dd> 741</dl> 742</li> 743</ul> 744<a name="getEmptyValue-com.fasterxml.jackson.databind.DeserializationContext-"> 745<!-- --> 746</a> 747<ul class="blockList"> 748<li class="blockList"> 749<h4>getEmptyValue</h4> 750<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getEmptyValue(<a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 751 throws <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 752<div class="block">Method called to determine value to be used for "empty" values 753 (most commonly when deserializing from empty JSON Strings). 754 Usually this is same as <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getNullValue(com.fasterxml.jackson.databind.DeserializationContext)</code></a> (which in turn 755 is usually simply Java null), but it can be overridden 756 for specific types. Or, if type should never be converted from empty 757 String, method can also throw an exception. 758<p> 759 This method may be called once, or multiple times, depending on what 760 <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getEmptyAccessPattern--"><code>getEmptyAccessPattern()</code></a> returns. 761<p> 762 Default implementation simply calls <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html#getNullValue-com.fasterxml.jackson.databind.DeserializationContext-"><code>getNullValue(com.fasterxml.jackson.databind.DeserializationContext)</code></a> and 763 returns value.</div> 764<dl> 765<dt><span class="throwsLabel">Throws:</span></dt> 766<dd><code><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> 767<dt><span class="simpleTagLabel">Since:</span></dt> 768<dd>2.6 Added to replace earlier no-arguments variant</dd> 769</dl> 770</li> 771</ul> 772<a name="getObjectIdReader--"> 773<!-- --> 774</a> 775<ul class="blockList"> 776<li class="blockList"> 777<h4>getObjectIdReader</h4> 778<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> 779<div class="block">Accessor that can be used to check whether this deserializer 780 is expecting to possibly get an Object Identifier value instead of full value 781 serialization, and if so, should be able to resolve it to actual 782 Object instance to return as deserialized value. 783<p> 784 Default implementation returns null, as support cannot be implemented 785 generically. Some standard deserializers (most notably 786 <a href="../../../../com/fasterxml/jackson/databind/deser/BeanDeserializer.html" title="class in com.fasterxml.jackson.databind.deser"><code>BeanDeserializer</code></a>) 787 do implement this feature, and may return reader instance, depending on exact 788 configuration of instance (which is based on type, and referring property).</div> 789<dl> 790<dt><span class="returnLabel">Returns:</span></dt> 791<dd>ObjectIdReader used for resolving possible Object Identifier 792 value, instead of full value serialization, if deserializer can do that; 793 null if no Object Id is expected.</dd> 794<dt><span class="simpleTagLabel">Since:</span></dt> 795<dd>2.0</dd> 796</dl> 797</li> 798</ul> 799<a name="findBackReference-java.lang.String-"> 800<!-- --> 801</a> 802<ul class="blockList"> 803<li class="blockList"> 804<h4>findBackReference</h4> 805<pre>public <a href="../../../../com/fasterxml/jackson/databind/deser/SettableBeanProperty.html" title="class in com.fasterxml.jackson.databind.deser">SettableBeanProperty</a> findBackReference(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> refName)</pre> 806<div class="block">Method needed by <a href="../../../../com/fasterxml/jackson/databind/deser/BeanDeserializerFactory.html" title="class in com.fasterxml.jackson.databind.deser"><code>BeanDeserializerFactory</code></a> to properly link 807 managed- and back-reference pairs.</div> 808<dl> 809<dt><span class="simpleTagLabel">Since:</span></dt> 810<dd>2.2 (was moved out of <code>BeanDeserializerBase</code>)</dd> 811</dl> 812</li> 813</ul> 814<a name="supportsUpdate-com.fasterxml.jackson.databind.DeserializationConfig-"> 815<!-- --> 816</a> 817<ul class="blockList"> 818<li class="blockList"> 819<h4>supportsUpdate</h4> 820<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</a> supportsUpdate(<a href="../../../../com/fasterxml/jackson/databind/DeserializationConfig.html" title="class in com.fasterxml.jackson.databind">DeserializationConfig</a> config)</pre> 821<div class="block">Introspection method that may be called to see whether deserializer supports 822 update of an existing value (aka "merging") or not. Return value should either 823 be <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#FALSE" title="class or interface in java.lang"><code>Boolean.FALSE</code></a> if update is not supported at all (immutable values); 824 <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#TRUE" title="class or interface in java.lang"><code>Boolean.TRUE</code></a> if update should usually work (regular POJOs, for example), 825 or <code>null</code> if this is either not known, or may sometimes work. 826<p> 827 Information gathered is typically used to either prevent merging update for 828 property (either by skipping, if based on global defaults; or by exception during 829 deserialization construction if explicit attempt made) if <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#FALSE" title="class or interface in java.lang"><code>Boolean.FALSE</code></a> 830 returned, or inclusion if <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html?is-external=true#TRUE" title="class or interface in java.lang"><code>Boolean.TRUE</code></a> is specified. If "unknown" case 831 (<code>null</code> returned) behavior is to exclude property if global defaults 832 used; or to allow if explicit per-type or property merging is defined. 833<p> 834 Default implementation returns <code>null</code> to allow explicit per-type 835 or per-property attempts.</div> 836<dl> 837<dt><span class="simpleTagLabel">Since:</span></dt> 838<dd>2.9</dd> 839</dl> 840</li> 841</ul> 842<a name="getNullValue--"> 843<!-- --> 844</a> 845<ul class="blockList"> 846<li class="blockList"> 847<h4>getNullValue</h4> 848<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 849public <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="type parameter in JsonDeserializer">T</a> getNullValue()</pre> 850<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.6 Use overloaded variant that takes context argument</span></div> 851</li> 852</ul> 853<a name="getEmptyValue--"> 854<!-- --> 855</a> 856<ul class="blockListLast"> 857<li class="blockList"> 858<h4>getEmptyValue</h4> 859<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 860public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getEmptyValue()</pre> 861<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.6 Use overloaded variant that takes context argument</span></div> 862</li> 863</ul> 864</li> 865</ul> 866</li> 867</ul> 868</div> 869</div> 870<!-- ========= END OF CLASS DATA ========= --> 871<!-- ======= START OF BOTTOM NAVBAR ====== --> 872<div class="bottomNav"><a name="navbar.bottom"> 873<!-- --> 874</a> 875<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 876<a name="navbar.bottom.firstrow"> 877<!-- --> 878</a> 879<ul class="navList" title="Navigation"> 880<li><a href="../../../../overview-summary.html">Overview</a></li> 881<li><a href="package-summary.html">Package</a></li> 882<li class="navBarCell1Rev">Class</li> 883<li><a href="class-use/JsonDeserializer.html">Use</a></li> 884<li><a href="package-tree.html">Tree</a></li> 885<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 886<li><a href="../../../../index-all.html">Index</a></li> 887<li><a href="../../../../help-doc.html">Help</a></li> 888</ul> 889</div> 890<div class="subNav"> 891<ul class="navList"> 892<li><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 893<li><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 894</ul> 895<ul class="navList"> 896<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonDeserializer.html" target="_top">Frames</a></li> 897<li><a href="JsonDeserializer.html" target="_top">No Frames</a></li> 898</ul> 899<ul class="navList" id="allclasses_navbar_bottom"> 900<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 901</ul> 902<div> 903<script type="text/javascript"><!-- 904 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 905 if(window==top) { 906 allClassesLink.style.display = "block"; 907 } 908 else { 909 allClassesLink.style.display = "none"; 910 } 911 //--> 912</script> 913</div> 914<div> 915<ul class="subNavList"> 916<li>Summary: </li> 917<li><a href="#nested.class.summary">Nested</a> | </li> 918<li>Field | </li> 919<li><a href="#constructor.summary">Constr</a> | </li> 920<li><a href="#method.summary">Method</a></li> 921</ul> 922<ul class="subNavList"> 923<li>Detail: </li> 924<li>Field | </li> 925<li><a href="#constructor.detail">Constr</a> | </li> 926<li><a href="#method.detail">Method</a></li> 927</ul> 928</div> 929<a name="skip.navbar.bottom"> 930<!-- --> 931</a></div> 932<!-- ======== END OF BOTTOM NAVBAR ======= --> 933<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 934</body> 935</html> 936