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 Nov 05 19:39:07 PST 2019 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>ContextualKeyDeserializer (jackson-databind 2.10.0 API)</title> 8<meta name="date" content="2019-11-05"> 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="ContextualKeyDeserializer (jackson-databind 2.10.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":6}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/ContextualKeyDeserializer.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/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html" target="_top">Frames</a></li> 58<li><a href="ContextualKeyDeserializer.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>Nested | </li> 79<li>Field | </li> 80<li>Constr | </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>Constr | </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.deser</div> 97<h2 title="Interface ContextualKeyDeserializer" class="title">Interface ContextualKeyDeserializer</h2> 98</div> 99<div class="contentContainer"> 100<div class="description"> 101<ul class="blockList"> 102<li class="blockList"> 103<hr> 104<br> 105<pre>public interface <span class="typeNameLabel">ContextualKeyDeserializer</span></pre> 106<div class="block">Add-on interface that <a href="../../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind"><code>KeyDeserializer</code></a>s can implement to get a callback 107 that can be used to create contextual instances of key deserializer to use for 108 handling Map keys of supported type. This can be useful 109 for key deserializers that can be configured by annotations, or should otherwise 110 have differing behavior depending on what kind of Map property keys are being deserialized.</div> 111</li> 112</ul> 113</div> 114<div class="summary"> 115<ul class="blockList"> 116<li class="blockList"> 117<!-- ========== METHOD SUMMARY =========== --> 118<ul class="blockList"> 119<li class="blockList"><a name="method.summary"> 120<!-- --> 121</a> 122<h3>Method Summary</h3> 123<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 124<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> 125<tr> 126<th class="colFirst" scope="col">Modifier and Type</th> 127<th class="colLast" scope="col">Method and Description</th> 128</tr> 129<tr id="i0" class="altColor"> 130<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer</a></code></td> 131<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html#createContextual-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.BeanProperty-">createContextual</a></span>(<a href="../../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 132 <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a> property)</code> 133<div class="block">Method called to see if a different (or differently configured) key deserializer 134 is needed to deserialize keys of specified Map property.</div> 135</td> 136</tr> 137</table> 138</li> 139</ul> 140</li> 141</ul> 142</div> 143<div class="details"> 144<ul class="blockList"> 145<li class="blockList"> 146<!-- ============ METHOD DETAIL ========== --> 147<ul class="blockList"> 148<li class="blockList"><a name="method.detail"> 149<!-- --> 150</a> 151<h3>Method Detail</h3> 152<a name="createContextual-com.fasterxml.jackson.databind.DeserializationContext-com.fasterxml.jackson.databind.BeanProperty-"> 153<!-- --> 154</a> 155<ul class="blockListLast"> 156<li class="blockList"> 157<h4>createContextual</h4> 158<pre><a href="../../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer</a> createContextual(<a href="../../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 159 <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a> property) 160 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 161<div class="block">Method called to see if a different (or differently configured) key deserializer 162 is needed to deserialize keys of specified Map property. 163 Note that instance that this method is called on is typically shared one and 164 as a result method should <b>NOT</b> modify this instance but rather construct 165 and return a new instance. This instance should only be returned as-is, in case 166 it is already suitable for use.</div> 167<dl> 168<dt><span class="paramLabel">Parameters:</span></dt> 169<dd><code>ctxt</code> - Deserialization context to access configuration, additional 170 deserializers that may be needed by this deserializer</dd> 171<dd><code>property</code> - Method, field or constructor parameter that declared Map for which 172 contextual instance will be used. Will not be available when deserializing root-level 173 Map value; otherwise should not be null.</dd> 174<dt><span class="returnLabel">Returns:</span></dt> 175<dd>Key deserializer to use for deserializing keys specified Map property, 176 may be this instance or a new instance.</dd> 177<dt><span class="throwsLabel">Throws:</span></dt> 178<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd> 179</dl> 180</li> 181</ul> 182</li> 183</ul> 184</li> 185</ul> 186</div> 187</div> 188<!-- ========= END OF CLASS DATA ========= --> 189<!-- ======= START OF BOTTOM NAVBAR ====== --> 190<div class="bottomNav"><a name="navbar.bottom"> 191<!-- --> 192</a> 193<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 194<a name="navbar.bottom.firstrow"> 195<!-- --> 196</a> 197<ul class="navList" title="Navigation"> 198<li><a href="../../../../../overview-summary.html">Overview</a></li> 199<li><a href="package-summary.html">Package</a></li> 200<li class="navBarCell1Rev">Class</li> 201<li><a href="class-use/ContextualKeyDeserializer.html">Use</a></li> 202<li><a href="package-tree.html">Tree</a></li> 203<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 204<li><a href="../../../../../index-all.html">Index</a></li> 205<li><a href="../../../../../help-doc.html">Help</a></li> 206</ul> 207</div> 208<div class="subNav"> 209<ul class="navList"> 210<li><a href="../../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><span class="typeNameLink">Prev Class</span></a></li> 211<li><a href="../../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser"><span class="typeNameLink">Next Class</span></a></li> 212</ul> 213<ul class="navList"> 214<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html" target="_top">Frames</a></li> 215<li><a href="ContextualKeyDeserializer.html" target="_top">No Frames</a></li> 216</ul> 217<ul class="navList" id="allclasses_navbar_bottom"> 218<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 219</ul> 220<div> 221<script type="text/javascript"><!-- 222 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 223 if(window==top) { 224 allClassesLink.style.display = "block"; 225 } 226 else { 227 allClassesLink.style.display = "none"; 228 } 229 //--> 230</script> 231</div> 232<div> 233<ul class="subNavList"> 234<li>Summary: </li> 235<li>Nested | </li> 236<li>Field | </li> 237<li>Constr | </li> 238<li><a href="#method.summary">Method</a></li> 239</ul> 240<ul class="subNavList"> 241<li>Detail: </li> 242<li>Field | </li> 243<li>Constr | </li> 244<li><a href="#method.detail">Method</a></li> 245</ul> 246</div> 247<a name="skip.navbar.bottom"> 248<!-- --> 249</a></div> 250<!-- ======== END OF BOTTOM NAVBAR ======= --> 251<p class="legalCopy"><small>Copyright © 2008–2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 252</body> 253</html> 254