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_35) on Tue Oct 09 17:08:08 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8Module (jackson-databind 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-09"> 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="Module (jackson-databind 2.1.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/Module.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/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface 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/Module.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="Module.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 Module</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.Module</B> 98</PRE> 99<DL> 100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</A></DD> 101</DL> 102<DL> 103<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../com/fasterxml/jackson/databind/module/SimpleModule.html" title="class in com.fasterxml.jackson.databind.module">SimpleModule</A></DD> 104</DL> 105<HR> 106<DL> 107<DT><PRE>public abstract class <B>Module</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><DT>implements <A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</A></DL> 108</PRE> 109 110<P> 111Simple interface for extensions that can be registered with <A HREF="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectMapper</CODE></A> 112 to provide a well-defined set of extensions to default functionality; such as 113 support for new data types. 114<P> 115 116<P> 117<HR> 118 119<P> 120<!-- ======== NESTED CLASS SUMMARY ======== --> 121 122<A NAME="nested_class_summary"><!-- --></A> 123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 126<B>Nested Class Summary</B></FONT></TH> 127</TR> 128<TR BGCOLOR="white" CLASS="TableRowColor"> 129<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 130<CODE>static interface</CODE></FONT></TD> 131<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</A></B></CODE> 132 133<BR> 134 Interface Jackson exposes to modules for purpose of registering 135 extended functionality.</TD> 136</TR> 137</TABLE> 138 139<!-- ======== CONSTRUCTOR SUMMARY ======== --> 140 141<A NAME="constructor_summary"><!-- --></A> 142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 145<B>Constructor Summary</B></FONT></TH> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/Module.html#Module()">Module</A></B>()</CODE> 149 150<BR> 151 </TD> 152</TR> 153</TABLE> 154 155<!-- ========== METHOD SUMMARY =========== --> 156 157<A NAME="method_summary"><!-- --></A> 158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 161<B>Method Summary</B></FONT></TH> 162</TR> 163<TR BGCOLOR="white" CLASS="TableRowColor"> 164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 165<CODE>abstract <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></CODE></FONT></TD> 166<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/Module.html#getModuleName()">getModuleName</A></B>()</CODE> 167 168<BR> 169 Method that returns identifier for module; this can be used by Jackson 170 for informational purposes, as well as in associating extensions with 171 module that provides them.</TD> 172</TR> 173<TR BGCOLOR="white" CLASS="TableRowColor"> 174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 175<CODE>abstract void</CODE></FONT></TD> 176<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/Module.html#setupModule(com.fasterxml.jackson.databind.Module.SetupContext)">setupModule</A></B>(<A HREF="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</A> context)</CODE> 177 178<BR> 179 Method called by <A HREF="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectMapper</CODE></A> when module is registered.</TD> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 183<CODE>abstract <A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</A></CODE></FONT></TD> 184<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/databind/Module.html#version()">version</A></B>()</CODE> 185 186<BR> 187 Method that returns version of this module.</TD> 188</TR> 189</TABLE> 190 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 191<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 192<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 193<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> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<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> 197</TR> 198</TABLE> 199 200<P> 201 202<!-- ========= CONSTRUCTOR DETAIL ======== --> 203 204<A NAME="constructor_detail"><!-- --></A> 205<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 206<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 207<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 208<B>Constructor Detail</B></FONT></TH> 209</TR> 210</TABLE> 211 212<A NAME="Module()"><!-- --></A><H3> 213Module</H3> 214<PRE> 215public <B>Module</B>()</PRE> 216<DL> 217</DL> 218 219<!-- ============ METHOD DETAIL ========== --> 220 221<A NAME="method_detail"><!-- --></A> 222<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 223<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 224<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 225<B>Method Detail</B></FONT></TH> 226</TR> 227</TABLE> 228 229<A NAME="getModuleName()"><!-- --></A><H3> 230getModuleName</H3> 231<PRE> 232public abstract <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> <B>getModuleName</B>()</PRE> 233<DL> 234<DD>Method that returns identifier for module; this can be used by Jackson 235 for informational purposes, as well as in associating extensions with 236 module that provides them. 237<P> 238<DD><DL> 239</DL> 240</DD> 241<DD><DL> 242</DL> 243</DD> 244</DL> 245<HR> 246 247<A NAME="version()"><!-- --></A><H3> 248version</H3> 249<PRE> 250public abstract <A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</A> <B>version</B>()</PRE> 251<DL> 252<DD>Method that returns version of this module. Can be used by Jackson for 253 informational purposes. 254<P> 255<DD><DL> 256<DT><B>Specified by:</B><DD><CODE><A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Versioned.html?is-external=true#version()" title="class or interface in com.fasterxml.jackson.core">version</A></CODE> in interface <CODE><A HREF="http://fasterxml.github.com/jackson-core/javadoc/2.1.0/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</A></CODE></DL> 257</DD> 258<DD><DL> 259</DL> 260</DD> 261</DL> 262<HR> 263 264<A NAME="setupModule(com.fasterxml.jackson.databind.Module.SetupContext)"><!-- --></A><H3> 265setupModule</H3> 266<PRE> 267public abstract void <B>setupModule</B>(<A HREF="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</A> context)</PRE> 268<DL> 269<DD>Method called by <A HREF="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><CODE>ObjectMapper</CODE></A> when module is registered. 270 It is called to let module register functionality it provides, 271 using callback methods passed-in context object exposes. 272<P> 273<DD><DL> 274</DL> 275</DD> 276<DD><DL> 277</DL> 278</DD> 279</DL> 280<!-- ========= END OF CLASS DATA ========= --> 281<HR> 282 283 284<!-- ======= START OF BOTTOM NAVBAR ====== --> 285<A NAME="navbar_bottom"><!-- --></A> 286<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 287<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 288<TR> 289<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 290<A NAME="navbar_bottom_firstrow"><!-- --></A> 291<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 292 <TR ALIGN="center" VALIGN="top"> 293 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 294 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 295 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 296 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Module.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 297 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 300 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 301 </TR> 302</TABLE> 303</TD> 304<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 305</EM> 306</TD> 307</TR> 308 309<TR> 310<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 311 <A HREF="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><B>PREV CLASS</B></A> 312 <A HREF="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind"><B>NEXT CLASS</B></A></FONT></TD> 313<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 314 <A HREF="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top"><B>FRAMES</B></A> 315 <A HREF="Module.html" target="_top"><B>NO FRAMES</B></A> 316 <SCRIPT type="text/javascript"> 317 <!-- 318 if(window==top) { 319 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 320 } 321 //--> 322</SCRIPT> 323<NOSCRIPT> 324 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 325</NOSCRIPT> 326 327 328</FONT></TD> 329</TR> 330<TR> 331<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 332 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 333<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 334DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 335</TR> 336</TABLE> 337<A NAME="skip-navbar_bottom"></A> 338<!-- ======== END OF BOTTOM NAVBAR ======= --> 339 340<HR> 341Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 342</BODY> 343</HTML> 344
