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 Sun Jul 14 20:03:25 PDT 2013 --> 6<title>ContextualKeyDeserializer (Jackson JSON Processor)</title> 7<meta name="date" content="2013-07-14"> 8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 9</head> 10<body> 11<script type="text/javascript"><!-- 12 if (location.href.indexOf('is-external=true') == -1) { 13 parent.document.title="ContextualKeyDeserializer (Jackson JSON Processor)"; 14 } 15//--> 16</script> 17<noscript> 18<div>JavaScript is disabled on your browser.</div> 19</noscript> 20<!-- ========= START OF TOP NAVBAR ======= --> 21<div class="topNav"><a name="navbar_top"> 22<!-- --> 23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 24<!-- --> 25</a> 26<ul class="navList" title="Navigation"> 27<li><a href="../../../../overview-summary.html">Overview</a></li> 28<li><a href="package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/ContextualKeyDeserializer.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../../index-all.html">Index</a></li> 34<li><a href="../../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../../org/codehaus/jackson/map/ContextualDeserializer.html" title="interface in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../org/codehaus/jackson/map/ContextualSerializer.html" title="interface in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?org/codehaus/jackson/map/ContextualKeyDeserializer.html" target="_top">Frames</a></li> 44<li><a href="ContextualKeyDeserializer.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Nested | </li> 65<li>Field | </li> 66<li>Constr | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li>Field | </li> 72<li>Constr | </li> 73<li><a href="#method_detail">Method</a></li> 74</ul> 75</div> 76<a name="skip-navbar_top"> 77<!-- --> 78</a></div> 79<!-- ========= END OF TOP NAVBAR ========= --> 80<!-- ======== START OF CLASS DATA ======== --> 81<div class="header"> 82<div class="subTitle">org.codehaus.jackson.map</div> 83<h2 title="Interface ContextualKeyDeserializer" class="title">Interface ContextualKeyDeserializer</h2> 84</div> 85<div class="contentContainer"> 86<div class="description"> 87<ul class="blockList"> 88<li class="blockList"> 89<hr> 90<br> 91<pre>public interface <span class="strong">ContextualKeyDeserializer</span></pre> 92<div class="block">Add-on interface that <a href="../../../../org/codehaus/jackson/map/KeyDeserializer.html" title="class in org.codehaus.jackson.map"><code>KeyDeserializer</code></a>s can implement to get a callback 93 that can be used to create contextual instances of key deserializer to use for 94 handling Map keys of supported type. This can be useful 95 for key deserializers that can be configured by annotations, or should otherwise 96 have differing behavior depending on what kind of Map property keys are being deserialized.</div> 97<dl><dt><span class="strong">Since:</span></dt> 98 <dd>1.8</dd></dl> 99</li> 100</ul> 101</div> 102<div class="summary"> 103<ul class="blockList"> 104<li class="blockList"> 105<!-- ========== METHOD SUMMARY =========== --> 106<ul class="blockList"> 107<li class="blockList"><a name="method_summary"> 108<!-- --> 109</a> 110<h3>Method Summary</h3> 111<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 112<caption><span>Methods</span><span class="tabEnd"> </span></caption> 113<tr> 114<th class="colFirst" scope="col">Modifier and Type</th> 115<th class="colLast" scope="col">Method and Description</th> 116</tr> 117<tr class="altColor"> 118<td class="colFirst"><code><a href="../../../../org/codehaus/jackson/map/KeyDeserializer.html" title="class in org.codehaus.jackson.map">KeyDeserializer</a></code></td> 119<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/ContextualKeyDeserializer.html#createContextual(org.codehaus.jackson.map.DeserializationConfig, org.codehaus.jackson.map.BeanProperty)">createContextual</a></strong>(<a href="../../../../org/codehaus/jackson/map/DeserializationConfig.html" title="class in org.codehaus.jackson.map">DeserializationConfig</a> config, 120 <a href="../../../../org/codehaus/jackson/map/BeanProperty.html" title="interface in org.codehaus.jackson.map">BeanProperty</a> property)</code> 121<div class="block">Method called to see if a different (or differently configured) key deserializer 122 is needed to deserialize keys of specified Map property.</div> 123</td> 124</tr> 125</table> 126</li> 127</ul> 128</li> 129</ul> 130</div> 131<div class="details"> 132<ul class="blockList"> 133<li class="blockList"> 134<!-- ============ METHOD DETAIL ========== --> 135<ul class="blockList"> 136<li class="blockList"><a name="method_detail"> 137<!-- --> 138</a> 139<h3>Method Detail</h3> 140<a name="createContextual(org.codehaus.jackson.map.DeserializationConfig, org.codehaus.jackson.map.BeanProperty)"> 141<!-- --> 142</a> 143<ul class="blockListLast"> 144<li class="blockList"> 145<h4>createContextual</h4> 146<pre><a href="../../../../org/codehaus/jackson/map/KeyDeserializer.html" title="class in org.codehaus.jackson.map">KeyDeserializer</a> createContextual(<a href="../../../../org/codehaus/jackson/map/DeserializationConfig.html" title="class in org.codehaus.jackson.map">DeserializationConfig</a> config, 147 <a href="../../../../org/codehaus/jackson/map/BeanProperty.html" title="interface in org.codehaus.jackson.map">BeanProperty</a> property) 148 throws <a href="../../../../org/codehaus/jackson/map/JsonMappingException.html" title="class in org.codehaus.jackson.map">JsonMappingException</a></pre> 149<div class="block">Method called to see if a different (or differently configured) key deserializer 150 is needed to deserialize keys of specified Map property. 151 Note that instance that this method is called on is typically shared one and 152 as a result method should <b>NOT</b> modify this instance but rather construct 153 and return a new instance. This instance should only be returned as-is, in case 154 it is already suitable for use.</div> 155<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - Current deserialization configuration</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="../../../../org/codehaus/jackson/map/JsonMappingException.html" title="class in org.codehaus.jackson.map">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="../../../../org/codehaus/jackson/map/ContextualDeserializer.html" title="interface in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li> 191<li><a href="../../../../org/codehaus/jackson/map/ContextualSerializer.html" title="interface in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li> 192</ul> 193<ul class="navList"> 194<li><a href="../../../../index.html?org/codehaus/jackson/map/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</body> 232</html> 233