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 Sat Apr 25 17:14:48 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>KeyDeserializer (jackson-databind 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 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="KeyDeserializer (jackson-databind 2.11.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/KeyDeserializer.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/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.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/KeyDeserializer.html" target="_top">Frames</a></li> 58<li><a href="KeyDeserializer.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 KeyDeserializer" class="title">Class KeyDeserializer</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.KeyDeserializer</li> 105</ul> 106</li> 107</ul> 108<div class="description"> 109<ul class="blockList"> 110<li class="blockList"> 111<dl> 112<dt>Direct Known Subclasses:</dt> 113<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> 114</dl> 115<hr> 116<br> 117<pre>public abstract class <span class="typeNameLabel">KeyDeserializer</span> 118extends <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></pre> 119<div class="block">Abstract class that defines API used for deserializing JSON content 120 field names into Java Map keys. These deserializers are only used 121 if the Map key class is not <code>String</code> or <code>Object</code>.</div> 122</li> 123</ul> 124</div> 125<div class="summary"> 126<ul class="blockList"> 127<li class="blockList"> 128<!-- ======== NESTED CLASS SUMMARY ======== --> 129<ul class="blockList"> 130<li class="blockList"><a name="nested.class.summary"> 131<!-- --> 132</a> 133<h3>Nested Class Summary</h3> 134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 135<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 136<tr> 137<th class="colFirst" scope="col">Modifier and Type</th> 138<th class="colLast" scope="col">Class and Description</th> 139</tr> 140<tr class="altColor"> 141<td class="colFirst"><code>static class </code></td> 142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</a></span></code> 143<div class="block">This marker class is only to be used with annotations, to 144 indicate that <b>no deserializer is configured</b>.</div> 145</td> 146</tr> 147</table> 148</li> 149</ul> 150<!-- ======== CONSTRUCTOR SUMMARY ======== --> 151<ul class="blockList"> 152<li class="blockList"><a name="constructor.summary"> 153<!-- --> 154</a> 155<h3>Constructor Summary</h3> 156<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 157<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 158<tr> 159<th class="colOne" scope="col">Constructor and Description</th> 160</tr> 161<tr class="altColor"> 162<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#KeyDeserializer--">KeyDeserializer</a></span>()</code> </td> 163</tr> 164</table> 165</li> 166</ul> 167<!-- ========== METHOD SUMMARY =========== --> 168<ul class="blockList"> 169<li class="blockList"><a name="method.summary"> 170<!-- --> 171</a> 172<h3>Method Summary</h3> 173<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 174<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> 175<tr> 176<th class="colFirst" scope="col">Modifier and Type</th> 177<th class="colLast" scope="col">Method and Description</th> 178</tr> 179<tr id="i0" class="altColor"> 180<td class="colFirst"><code>abstract <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> 181<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#deserializeKey-java.lang.String-com.fasterxml.jackson.databind.DeserializationContext-">deserializeKey</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> key, 182 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt)</code> 183<div class="block">Method called to deserialize a <a href="https://docs.oracle.com/javase/8/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> 184</td> 185</tr> 186</table> 187<ul class="blockList"> 188<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 189<!-- --> 190</a> 191<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> 192<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> 193</ul> 194</li> 195</ul> 196</li> 197</ul> 198</div> 199<div class="details"> 200<ul class="blockList"> 201<li class="blockList"> 202<!-- ========= CONSTRUCTOR DETAIL ======== --> 203<ul class="blockList"> 204<li class="blockList"><a name="constructor.detail"> 205<!-- --> 206</a> 207<h3>Constructor Detail</h3> 208<a name="KeyDeserializer--"> 209<!-- --> 210</a> 211<ul class="blockListLast"> 212<li class="blockList"> 213<h4>KeyDeserializer</h4> 214<pre>public KeyDeserializer()</pre> 215</li> 216</ul> 217</li> 218</ul> 219<!-- ============ METHOD DETAIL ========== --> 220<ul class="blockList"> 221<li class="blockList"><a name="method.detail"> 222<!-- --> 223</a> 224<h3>Method Detail</h3> 225<a name="deserializeKey-java.lang.String-com.fasterxml.jackson.databind.DeserializationContext-"> 226<!-- --> 227</a> 228<ul class="blockListLast"> 229<li class="blockList"> 230<h4>deserializeKey</h4> 231<pre>public abstract <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> deserializeKey(<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> key, 232 <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a> ctxt) 233 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> 234<div class="block">Method called to deserialize a <a href="https://docs.oracle.com/javase/8/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> 235<dl> 236<dt><span class="throwsLabel">Throws:</span></dt> 237<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> 238</dl> 239</li> 240</ul> 241</li> 242</ul> 243</li> 244</ul> 245</div> 246</div> 247<!-- ========= END OF CLASS DATA ========= --> 248<!-- ======= START OF BOTTOM NAVBAR ====== --> 249<div class="bottomNav"><a name="navbar.bottom"> 250<!-- --> 251</a> 252<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 253<a name="navbar.bottom.firstrow"> 254<!-- --> 255</a> 256<ul class="navList" title="Navigation"> 257<li><a href="../../../../overview-summary.html">Overview</a></li> 258<li><a href="package-summary.html">Package</a></li> 259<li class="navBarCell1Rev">Class</li> 260<li><a href="class-use/KeyDeserializer.html">Use</a></li> 261<li><a href="package-tree.html">Tree</a></li> 262<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 263<li><a href="../../../../index-all.html">Index</a></li> 264<li><a href="../../../../help-doc.html">Help</a></li> 265</ul> 266</div> 267<div class="subNav"> 268<ul class="navList"> 269<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 270<li><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 271</ul> 272<ul class="navList"> 273<li><a href="../../../../index.html?com/fasterxml/jackson/databind/KeyDeserializer.html" target="_top">Frames</a></li> 274<li><a href="KeyDeserializer.html" target="_top">No Frames</a></li> 275</ul> 276<ul class="navList" id="allclasses_navbar_bottom"> 277<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 278</ul> 279<div> 280<script type="text/javascript"><!-- 281 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 282 if(window==top) { 283 allClassesLink.style.display = "block"; 284 } 285 else { 286 allClassesLink.style.display = "none"; 287 } 288 //--> 289</script> 290</div> 291<div> 292<ul class="subNavList"> 293<li>Summary: </li> 294<li><a href="#nested.class.summary">Nested</a> | </li> 295<li>Field | </li> 296<li><a href="#constructor.summary">Constr</a> | </li> 297<li><a href="#method.summary">Method</a></li> 298</ul> 299<ul class="subNavList"> 300<li>Detail: </li> 301<li>Field | </li> 302<li><a href="#constructor.detail">Constr</a> | </li> 303<li><a href="#method.detail">Method</a></li> 304</ul> 305</div> 306<a name="skip.navbar.bottom"> 307<!-- --> 308</a></div> 309<!-- ======== END OF BOTTOM NAVBAR ======= --> 310<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 311</body> 312</html> 313