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_79) on Wed Jul 20 08:39:11 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>ContextualKeyDeserializer (jackson-databind 2.8.0 API)</title> 8<meta name="date" content="2016-07-20"> 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="ContextualKeyDeserializer (jackson-databind 2.8.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/ContextualKeyDeserializer.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/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html" target="_top">Frames</a></li> 45<li><a href="ContextualKeyDeserializer.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>Nested | </li> 66<li>Field | </li> 67<li>Constr | </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>Constr | </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.deser</div> 84<h2 title="Interface ContextualKeyDeserializer" class="title">Interface ContextualKeyDeserializer</h2> 85</div> 86<div class="contentContainer"> 87<div class="description"> 88<ul class="blockList"> 89<li class="blockList"> 90<hr> 91<br> 92<pre>public interface <span class="strong">ContextualKeyDeserializer</span></pre> 93<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 94 that can be used to create contextual instances of key deserializer to use for 95 handling Map keys of supported type. This can be useful 96 for key deserializers that can be configured by annotations, or should otherwise 97 have differing behavior depending on what kind of Map property keys are being deserialized.</div> 98</li> 99</ul> 100</div> 101<div class="summary"> 102<ul class="blockList"> 103<li class="blockList"> 104<!-- ========== METHOD SUMMARY =========== --> 105<ul class="blockList"> 106<li class="blockList"><a name="method_summary"> 107<!-- --> 108</a> 109<h3>Method Summary</h3> 110<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 111<caption><span>Methods</span><span class="tabEnd"> </span></caption> 112<tr> 113<th class="colFirst" scope="col">Modifier and Type</th> 114<th class="colLast" scope="col">Method and Description</th> 115</tr> 116<tr class="altColor"> 117<td class="colFirst"><code><a href="../../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer</a></code></td> 118<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html#createContextual(com.fasterxml.jackson.databind.DeserializationContext,%20com.fasterxml.jackson.databind.BeanProperty)">createContextual</a></strong>(<a href="../../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt, 119 <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a> property)</code> 120<div class="block">Method called to see if a different (or differently configured) key deserializer 121 is needed to deserialize keys of specified Map property.</div> 122</td> 123</tr> 124</table> 125</li> 126</ul> 127</li> 128</ul> 129</div> 130<div class="details"> 131<ul class="blockList"> 132<li class="blockList"> 133<!-- ============ METHOD DETAIL ========== --> 134<ul class="blockList"> 135<li class="blockList"><a name="method_detail"> 136<!-- --> 137</a> 138<h3>Method Detail</h3> 139<a name="createContextual(com.fasterxml.jackson.databind.DeserializationContext, com.fasterxml.jackson.databind.BeanProperty)"> 140<!-- --> 141</a> 142<ul class="blockListLast"> 143<li class="blockList"> 144<h4>createContextual</h4> 145<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, 146 <a href="../../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a> property) 147 throws <a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></pre> 148<div class="block">Method called to see if a different (or differently configured) key deserializer 149 is needed to deserialize keys of specified Map property. 150 Note that instance that this method is called on is typically shared one and 151 as a result method should <b>NOT</b> modify this instance but rather construct 152 and return a new instance. This instance should only be returned as-is, in case 153 it is already suitable for use.</div> 154<dl><dt><span class="strong">Parameters:</span></dt><dd><code>ctxt</code> - Deserialization context to access configuration, additional 155 deserializers that may be needed by this deserializer</dd><dd><code>property</code> - Method, field or constructor parameter that declared Map for which 156 contextual instance will be used. Will not be available when deserializing root-level 157 Map value; otherwise should not be null.</dd> 158<dt><span class="strong">Returns:</span></dt><dd>Key deserializer to use for deserializing keys specified Map property, 159 may be this instance or a new instance.</dd> 160<dt><span class="strong">Throws:</span></dt> 161<dd><code><a href="../../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></code></dd></dl> 162</li> 163</ul> 164</li> 165</ul> 166</li> 167</ul> 168</div> 169</div> 170<!-- ========= END OF CLASS DATA ========= --> 171<!-- ======= START OF BOTTOM NAVBAR ====== --> 172<div class="bottomNav"><a name="navbar_bottom"> 173<!-- --> 174</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 175<!-- --> 176</a> 177<ul class="navList" title="Navigation"> 178<li><a href="../../../../../overview-summary.html">Overview</a></li> 179<li><a href="package-summary.html">Package</a></li> 180<li class="navBarCell1Rev">Class</li> 181<li><a href="class-use/ContextualKeyDeserializer.html">Use</a></li> 182<li><a href="package-tree.html">Tree</a></li> 183<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 184<li><a href="../../../../../index-all.html">Index</a></li> 185<li><a href="../../../../../help-doc.html">Help</a></li> 186</ul> 187</div> 188<div class="subNav"> 189<ul class="navList"> 190<li><a href="../../../../../com/fasterxml/jackson/databind/deser/ContextualDeserializer.html" title="interface in com.fasterxml.jackson.databind.deser"><span class="strong">Prev Class</span></a></li> 191<li><a href="../../../../../com/fasterxml/jackson/databind/deser/CreatorProperty.html" title="class in com.fasterxml.jackson.databind.deser"><span class="strong">Next Class</span></a></li> 192</ul> 193<ul class="navList"> 194<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/deser/ContextualKeyDeserializer.html" target="_top">Frames</a></li> 195<li><a href="ContextualKeyDeserializer.html" target="_top">No Frames</a></li> 196</ul> 197<ul class="navList" id="allclasses_navbar_bottom"> 198<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 199</ul> 200<div> 201<script type="text/javascript"><!-- 202 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 203 if(window==top) { 204 allClassesLink.style.display = "block"; 205 } 206 else { 207 allClassesLink.style.display = "none"; 208 } 209 //--> 210</script> 211</div> 212<div> 213<ul class="subNavList"> 214<li>Summary: </li> 215<li>Nested | </li> 216<li>Field | </li> 217<li>Constr | </li> 218<li><a href="#method_summary">Method</a></li> 219</ul> 220<ul class="subNavList"> 221<li>Detail: </li> 222<li>Field | </li> 223<li>Constr | </li> 224<li><a href="#method_detail">Method</a></li> 225</ul> 226</div> 227<a name="skip-navbar_bottom"> 228<!-- --> 229</a></div> 230<!-- ======== END OF BOTTOM NAVBAR ======= --> 231<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 232</body> 233</html> 234