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 Mon Apr 22 19:50:32 PDT 2013 --> 6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> 7<title>Module (jackson-databind 2.2.0 API)</title> 8<meta name="date" content="2013-04-22"> 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="Module (jackson-databind 2.2.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/Module.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/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface 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/Module.html" target="_top">Frames</a></li> 45<li><a href="Module.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 Module" class="title">Class Module</h2> 85</div> 86<div class="contentContainer"> 87<ul class="inheritance"> 88<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> 89<li> 90<ul class="inheritance"> 91<li>com.fasterxml.jackson.databind.Module</li> 92</ul> 93</li> 94</ul> 95<div class="description"> 96<ul class="blockList"> 97<li class="blockList"> 98<dl> 99<dt>All Implemented Interfaces:</dt> 100<dd><a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/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>Direct Known Subclasses:</dt> 104<dd><a href="../../../../com/fasterxml/jackson/databind/module/SimpleModule.html" title="class in com.fasterxml.jackson.databind.module">SimpleModule</a></dd> 105</dl> 106<hr> 107<br> 108<pre>public abstract class <span class="strong">Module</span> 109extends <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> 110implements <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></pre> 111<div class="block">Simple 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.</div> 114</li> 115</ul> 116</div> 117<div class="summary"> 118<ul class="blockList"> 119<li class="blockList"> 120<!-- ======== NESTED CLASS SUMMARY ======== --> 121<ul class="blockList"> 122<li class="blockList"><a name="nested_class_summary"> 123<!-- --> 124</a> 125<h3>Nested Class Summary</h3> 126<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 127<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 128<tr> 129<th class="colFirst" scope="col">Modifier and Type</th> 130<th class="colLast" scope="col">Class and Description</th> 131</tr> 132<tr class="altColor"> 133<td class="colFirst"><code>static interface </code></td> 134<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a></strong></code> 135<div class="block">Interface Jackson exposes to modules for purpose of registering 136 extended functionality.</div> 137</td> 138</tr> 139</table> 140</li> 141</ul> 142<!-- ======== CONSTRUCTOR SUMMARY ======== --> 143<ul class="blockList"> 144<li class="blockList"><a name="constructor_summary"> 145<!-- --> 146</a> 147<h3>Constructor Summary</h3> 148<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 149<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 150<tr> 151<th class="colOne" scope="col">Constructor and Description</th> 152</tr> 153<tr class="altColor"> 154<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#Module()">Module</a></strong>()</code> </td> 155</tr> 156</table> 157</li> 158</ul> 159<!-- ========== METHOD SUMMARY =========== --> 160<ul class="blockList"> 161<li class="blockList"><a name="method_summary"> 162<!-- --> 163</a> 164<h3>Method Summary</h3> 165<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 166<caption><span>Methods</span><span class="tabEnd"> </span></caption> 167<tr> 168<th class="colFirst" scope="col">Modifier and Type</th> 169<th class="colLast" scope="col">Method and Description</th> 170</tr> 171<tr class="altColor"> 172<td class="colFirst"><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></td> 173<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#getModuleName()">getModuleName</a></strong>()</code> 174<div class="block">Method that returns identifier for module; this can be used by Jackson 175 for informational purposes, as well as in associating extensions with 176 module that provides them.</div> 177</td> 178</tr> 179<tr class="rowColor"> 180<td class="colFirst"><code>abstract void</code></td> 181<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#setupModule(com.fasterxml.jackson.databind.Module.SetupContext)">setupModule</a></strong>(<a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a> context)</code> 182<div class="block">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.</div> 183</td> 184</tr> 185<tr class="altColor"> 186<td class="colFirst"><code>abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a></code></td> 187<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#version()">version</a></strong>()</code> 188<div class="block">Method that returns version of this module.</div> 189</td> 190</tr> 191</table> 192<ul class="blockList"> 193<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 194<!-- --> 195</a> 196<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> 197<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> 198</ul> 199</li> 200</ul> 201</li> 202</ul> 203</div> 204<div class="details"> 205<ul class="blockList"> 206<li class="blockList"> 207<!-- ========= CONSTRUCTOR DETAIL ======== --> 208<ul class="blockList"> 209<li class="blockList"><a name="constructor_detail"> 210<!-- --> 211</a> 212<h3>Constructor Detail</h3> 213<a name="Module()"> 214<!-- --> 215</a> 216<ul class="blockListLast"> 217<li class="blockList"> 218<h4>Module</h4> 219<pre>public Module()</pre> 220</li> 221</ul> 222</li> 223</ul> 224<!-- ============ METHOD DETAIL ========== --> 225<ul class="blockList"> 226<li class="blockList"><a name="method_detail"> 227<!-- --> 228</a> 229<h3>Method Detail</h3> 230<a name="getModuleName()"> 231<!-- --> 232</a> 233<ul class="blockList"> 234<li class="blockList"> 235<h4>getModuleName</h4> 236<pre>public 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> getModuleName()</pre> 237<div class="block">Method that returns identifier for module; this can be used by Jackson 238 for informational purposes, as well as in associating extensions with 239 module that provides them.</div> 240</li> 241</ul> 242<a name="version()"> 243<!-- --> 244</a> 245<ul class="blockList"> 246<li class="blockList"> 247<h4>version</h4> 248<pre>public abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a> version()</pre> 249<div class="block">Method that returns version of this module. Can be used by Jackson for 250 informational purposes.</div> 251<dl> 252<dt><strong>Specified by:</strong></dt> 253<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.1.1/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.1/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></code></dd> 254</dl> 255</li> 256</ul> 257<a name="setupModule(com.fasterxml.jackson.databind.Module.SetupContext)"> 258<!-- --> 259</a> 260<ul class="blockListLast"> 261<li class="blockList"> 262<h4>setupModule</h4> 263<pre>public abstract void setupModule(<a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a> context)</pre> 264<div class="block">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. 265 It is called to let module register functionality it provides, 266 using callback methods passed-in context object exposes.</div> 267</li> 268</ul> 269</li> 270</ul> 271</li> 272</ul> 273</div> 274</div> 275<!-- ========= END OF CLASS DATA ========= --> 276<!-- ======= START OF BOTTOM NAVBAR ====== --> 277<div class="bottomNav"><a name="navbar_bottom"> 278<!-- --> 279</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 280<!-- --> 281</a> 282<ul class="navList" title="Navigation"> 283<li><a href="../../../../overview-summary.html">Overview</a></li> 284<li><a href="package-summary.html">Package</a></li> 285<li class="navBarCell1Rev">Class</li> 286<li><a href="class-use/Module.html">Use</a></li> 287<li><a href="package-tree.html">Tree</a></li> 288<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 289<li><a href="../../../../index-all.html">Index</a></li> 290<li><a href="../../../../help-doc.html">Help</a></li> 291</ul> 292</div> 293<div class="subNav"> 294<ul class="navList"> 295<li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 296<li><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind"><span class="strong">Next Class</span></a></li> 297</ul> 298<ul class="navList"> 299<li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> 300<li><a href="Module.html" target="_top">No Frames</a></li> 301</ul> 302<ul class="navList" id="allclasses_navbar_bottom"> 303<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 304</ul> 305<div> 306<script type="text/javascript"><!-- 307 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 308 if(window==top) { 309 allClassesLink.style.display = "block"; 310 } 311 else { 312 allClassesLink.style.display = "none"; 313 } 314 //--> 315</script> 316</div> 317<div> 318<ul class="subNavList"> 319<li>Summary: </li> 320<li><a href="#nested_class_summary">Nested</a> | </li> 321<li>Field | </li> 322<li><a href="#constructor_summary">Constr</a> | </li> 323<li><a href="#method_summary">Method</a></li> 324</ul> 325<ul class="subNavList"> 326<li>Detail: </li> 327<li>Field | </li> 328<li><a href="#constructor_detail">Constr</a> | </li> 329<li><a href="#method_detail">Method</a></li> 330</ul> 331</div> 332<a name="skip-navbar_bottom"> 333<!-- --> 334</a></div> 335<!-- ======== END OF BOTTOM NAVBAR ======= --> 336<p class="legalCopy"><small>Copyright © 2012-2013 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> 337</body> 338</html> 339