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