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:09 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>KeyDeserializer (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="KeyDeserializer (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/KeyDeserializer.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/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../index.html?com/fasterxml/jackson/databind/KeyDeserializer.html" target="_top">Frames</a></li> 45<li><a href="KeyDeserializer.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li><a href="#nested_class_summary">Nested</a> | </li> 66<li>Field | </li> 67<li><a href="#constructor_summary">Constr</a> | </li> 68<li><a href="#method_summary">Method</a></li> 69</ul> 70<ul class="subNavList"> 71<li>Detail: </li> 72<li>Field | </li> 73<li><a href="#constructor_detail">Constr</a> | </li> 74<li><a href="#method_detail">Method</a></li> 75</ul> 76</div> 77<a name="skip-navbar_top"> 78<!-- --> 79</a></div> 80<!-- ========= END OF TOP NAVBAR ========= --> 81<!-- ======== START OF CLASS DATA ======== --> 82<div class="header"> 83<div class="subTitle">com.fasterxml.jackson.databind</div> 84<h2 title="Class KeyDeserializer" class="title">Class KeyDeserializer</h2> 85</div> 86<div class="contentContainer"> 87<ul class="inheritance"> 88<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 89<li> 90<ul class="inheritance"> 91<li>com.fasterxml.jackson.databind.KeyDeserializer</li> 92</ul> 93</li> 94</ul> 95<div class="description"> 96<ul class="blockList"> 97<li class="blockList"> 98<dl> 99<dt>Direct Known Subclasses:</dt> 100<dd><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</a>, <a href="../../../../com/fasterxml/jackson/databind/deser/std/StdKeyDeserializer.html" title="class in com.fasterxml.jackson.databind.deser.std">StdKeyDeserializer</a></dd> 101</dl> 102<hr> 103<br> 104<pre>public abstract class <span class="strong">KeyDeserializer</span> 105extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> 106<div class="block">Abstract class that defines API used for deserializing JSON content 107 field names into Java Map keys. These deserializers are only used 108 if the Map key class is not <code>String</code> or <code>Object</code>.</div> 109</li> 110</ul> 111</div> 112<div class="summary"> 113<ul class="blockList"> 114<li class="blockList"> 115<!-- ======== NESTED CLASS SUMMARY ======== --> 116<ul class="blockList"> 117<li class="blockList"><a name="nested_class_summary"> 118<!-- --> 119</a> 120<h3>Nested Class Summary</h3> 121<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 122<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 123<tr> 124<th class="colFirst" scope="col">Modifier and Type</th> 125<th class="colLast" scope="col">Class and Description</th> 126</tr> 127<tr class="altColor"> 128<td class="colFirst"><code>static class </code></td> 129<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</a></strong></code> 130<div class="block">This marker class is only to be used with annotations, to 131 indicate that <b>no deserializer is configured</b>.</div> 132</td> 133</tr> 134</table> 135</li> 136</ul> 137<!-- ======== CONSTRUCTOR SUMMARY ======== --> 138<ul class="blockList"> 139<li class="blockList"><a name="constructor_summary"> 140<!-- --> 141</a> 142<h3>Constructor Summary</h3> 143<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 144<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 145<tr> 146<th class="colOne" scope="col">Constructor and Description</th> 147</tr> 148<tr class="altColor"> 149<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#KeyDeserializer()">KeyDeserializer</a></strong>()</code> </td> 150</tr> 151</table> 152</li> 153</ul> 154<!-- ========== METHOD SUMMARY =========== --> 155<ul class="blockList"> 156<li class="blockList"><a name="method_summary"> 157<!-- --> 158</a> 159<h3>Method Summary</h3> 160<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 161<caption><span>Methods</span><span class="tabEnd"> </span></caption> 162<tr> 163<th class="colFirst" scope="col">Modifier and Type</th> 164<th class="colLast" scope="col">Method and Description</th> 165</tr> 166<tr class="altColor"> 167<td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 168<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#deserializeKey(java.lang.String,%20com.fasterxml.jackson.databind.DeserializationContext)">deserializeKey</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, 169 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 170<div class="block">Method called to deserialize a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> key from JSON property name.</div> 171</td> 172</tr> 173</table> 174<ul class="blockList"> 175<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 176<!-- --> 177</a> 178<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 179<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> 180</ul> 181</li> 182</ul> 183</li> 184</ul> 185</div> 186<div class="details"> 187<ul class="blockList"> 188<li class="blockList"> 189<!-- ========= CONSTRUCTOR DETAIL ======== --> 190<ul class="blockList"> 191<li class="blockList"><a name="constructor_detail"> 192<!-- --> 193</a> 194<h3>Constructor Detail</h3> 195<a name="KeyDeserializer()"> 196<!-- --> 197</a> 198<ul class="blockListLast"> 199<li class="blockList"> 200<h4>KeyDeserializer</h4> 201<pre>public KeyDeserializer()</pre> 202</li> 203</ul> 204</li> 205</ul> 206<!-- ============ METHOD DETAIL ========== --> 207<ul class="blockList"> 208<li class="blockList"><a name="method_detail"> 209<!-- --> 210</a> 211<h3>Method Detail</h3> 212<a name="deserializeKey(java.lang.String, com.fasterxml.jackson.databind.DeserializationContext)"> 213<!-- --> 214</a> 215<ul class="blockListLast"> 216<li class="blockList"> 217<h4>deserializeKey</h4> 218<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> deserializeKey(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> key, 219 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 220 throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a>, 221 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></pre> 222<div class="block">Method called to deserialize a <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> key from JSON property name.</div> 223<dl><dt><span class="strong">Throws:</span></dt> 224<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd> 225<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/JsonProcessingException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">JsonProcessingException</a></code></dd></dl> 226</li> 227</ul> 228</li> 229</ul> 230</li> 231</ul> 232</div> 233</div> 234<!-- ========= END OF CLASS DATA ========= --> 235<!-- ======= START OF BOTTOM NAVBAR ====== --> 236<div class="bottomNav"><a name="navbar_bottom"> 237<!-- --> 238</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 239<!-- --> 240</a> 241<ul class="navList" title="Navigation"> 242<li><a href="../../../../overview-summary.html">Overview</a></li> 243<li><a href="package-summary.html">Package</a></li> 244<li class="navBarCell1Rev">Class</li> 245<li><a href="class-use/KeyDeserializer.html">Use</a></li> 246<li><a href="package-tree.html">Tree</a></li> 247<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 248<li><a href="../../../../index-all.html">Index</a></li> 249<li><a href="../../../../help-doc.html">Help</a></li> 250</ul> 251</div> 252<div class="subNav"> 253<ul class="navList"> 254<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 255<li><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 256</ul> 257<ul class="navList"> 258<li><a href="../../../../index.html?com/fasterxml/jackson/databind/KeyDeserializer.html" target="_top">Frames</a></li> 259<li><a href="KeyDeserializer.html" target="_top">No Frames</a></li> 260</ul> 261<ul class="navList" id="allclasses_navbar_bottom"> 262<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 263</ul> 264<div> 265<script type="text/javascript"><!-- 266 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 267 if(window==top) { 268 allClassesLink.style.display = "block"; 269 } 270 else { 271 allClassesLink.style.display = "none"; 272 } 273 //--> 274</script> 275</div> 276<div> 277<ul class="subNavList"> 278<li>Summary: </li> 279<li><a href="#nested_class_summary">Nested</a> | </li> 280<li>Field | </li> 281<li><a href="#constructor_summary">Constr</a> | </li> 282<li><a href="#method_summary">Method</a></li> 283</ul> 284<ul class="subNavList"> 285<li>Detail: </li> 286<li>Field | </li> 287<li><a href="#constructor_detail">Constr</a> | </li> 288<li><a href="#method_detail">Method</a></li> 289</ul> 290</div> 291<a name="skip-navbar_bottom"> 292<!-- --> 293</a></div> 294<!-- ======== END OF BOTTOM NAVBAR ======= --> 295<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 296</body> 297</html> 298