1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_29) on Mon Mar 26 19:07:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8KeyDeserializer (jackson-databind 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="KeyDeserializer (jackson-databind 2.0.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/KeyDeserializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/KeyDeserializer.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="KeyDeserializer.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.fasterxml.jackson.databind</FONT> 93<BR> 94Class KeyDeserializer</H2> 95<PRE> 96<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> 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>com.fasterxml.jackson.databind.KeyDeserializer</B> 98</PRE> 99<DL> 100<DT><B>Direct Known Subclasses:</B> <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<DL> 104<DT><PRE>public abstract class <B>KeyDeserializer</B><DT>extends <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></DL> 105</PRE> 106 107<P> 108Abstract class that defines API used for deserializing JSON content 109 field names into Java Map keys. These deserializers are only used 110 if the Map key class is not <code>String</code> or <code>Object</code>. 111<P> 112 113<P> 114<HR> 115 116<P> 117<!-- ======== NESTED CLASS SUMMARY ======== --> 118 119<A NAME="nested_class_summary"><!-- --></A> 120<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 121<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 122<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 123<B>Nested Class Summary</B></FONT></TH> 124</TR> 125<TR BGCOLOR="white" CLASS="TableRowColor"> 126<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 127<CODE>static class</CODE></FONT></TD> 128<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</A></B></CODE> 129 130<BR> 131 This marker class is only to be used with annotations, to 132 indicate that <b>no deserializer is configured</b>.</TD> 133</TR> 134</TABLE> 135 136<!-- ======== CONSTRUCTOR SUMMARY ======== --> 137 138<A NAME="constructor_summary"><!-- --></A> 139<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 140<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 141<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 142<B>Constructor Summary</B></FONT></TH> 143</TR> 144<TR BGCOLOR="white" CLASS="TableRowColor"> 145<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#KeyDeserializer()">KeyDeserializer</A></B>()</CODE> 146 147<BR> 148 </TD> 149</TR> 150</TABLE> 151 152<!-- ========== METHOD SUMMARY =========== --> 153 154<A NAME="method_summary"><!-- --></A> 155<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 156<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 157<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 158<B>Method Summary</B></FONT></TH> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<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></FONT></TD> 163<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html#deserializeKey(java.lang.String, com.fasterxml.jackson.databind.DeserializationContext)">deserializeKey</A></B>(<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, 164 <A HREF="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</A> ctxt)</CODE> 165 166<BR> 167 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.</TD> 168</TR> 169</TABLE> 170 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 171<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 172<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 173<TH ALIGN="left"><B>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></B></TH> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD><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></TD> 177</TR> 178</TABLE> 179 180<P> 181 182<!-- ========= CONSTRUCTOR DETAIL ======== --> 183 184<A NAME="constructor_detail"><!-- --></A> 185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 186<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 187<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 188<B>Constructor Detail</B></FONT></TH> 189</TR> 190</TABLE> 191 192<A NAME="KeyDeserializer()"><!-- --></A><H3> 193KeyDeserializer</H3> 194<PRE> 195public <B>KeyDeserializer</B>()</PRE> 196<DL> 197</DL> 198 199<!-- ============ METHOD DETAIL ========== --> 200 201<A NAME="method_detail"><!-- --></A> 202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 203<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 204<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 205<B>Method Detail</B></FONT></TH> 206</TR> 207</TABLE> 208 209<A NAME="deserializeKey(java.lang.String, com.fasterxml.jackson.databind.DeserializationContext)"><!-- --></A><H3> 210deserializeKey</H3> 211<PRE> 212public 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> <B>deserializeKey</B>(<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, 213 <A HREF="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</A> ctxt) 214 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>, 215 com.fasterxml.jackson.core.JsonProcessingException</PRE> 216<DL> 217<DD>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. 218<P> 219<DD><DL> 220 221<DT><B>Throws:</B> 222<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> 223<DD><CODE>com.fasterxml.jackson.core.JsonProcessingException</CODE></DL> 224</DD> 225</DL> 226<!-- ========= END OF CLASS DATA ========= --> 227<HR> 228 229 230<!-- ======= START OF BOTTOM NAVBAR ====== --> 231<A NAME="navbar_bottom"><!-- --></A> 232<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 233<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 234<TR> 235<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 236<A NAME="navbar_bottom_firstrow"><!-- --></A> 237<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 238 <TR ALIGN="center" VALIGN="top"> 239 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 240 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 241 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 242 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/KeyDeserializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 243 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 244 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 245 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 246 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 247 </TR> 248</TABLE> 249</TD> 250<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 251</EM> 252</TD> 253</TR> 254 255<TR> 256<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 257 <A HREF="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 258 <A HREF="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 259<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 260 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/KeyDeserializer.html" target="_top"><B>FRAMES</B></A> 261 <A HREF="KeyDeserializer.html" target="_top"><B>NO FRAMES</B></A> 262 <SCRIPT type="text/javascript"> 263 <!-- 264 if(window==top) { 265 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 266 } 267 //--> 268</SCRIPT> 269<NOSCRIPT> 270 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 271</NOSCRIPT> 272 273 274</FONT></TD> 275</TR> 276<TR> 277<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 278 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 279<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 280DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 281</TR> 282</TABLE> 283<A NAME="skip-navbar_bottom"></A> 284<!-- ======== END OF BOTTOM NAVBAR ======= --> 285 286<HR> 287Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 288</BODY> 289</HTML> 290
