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_79) on Wed Jul 20 08:39:09 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Module (jackson-databind 2.8.0 API)</title> 8<meta name="date" content="2016-07-20"> 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.8.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/7/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.7/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/7/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.7/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/7/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 a display that 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><a href="http://docs.oracle.com/javase/7/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><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#getTypeId()">getTypeId</a></strong>()</code> 182<div class="block">Method that returns an id that may be used to determine if two <a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind"><code>Module</code></a> 183 instances are considered to be of same type, for purpose of preventing 184 multiple registrations of "same type of" module 185 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 186 If `null` is returned, every instance is considered unique.</div> 187</td> 188</tr> 189<tr class="altColor"> 190<td class="colFirst"><code>abstract void</code></td> 191<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> 192<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> 193</td> 194</tr> 195<tr class="rowColor"> 196<td class="colFirst"><code>abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a></code></td> 197<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#version()">version</a></strong>()</code> 198<div class="block">Method that returns version of this module.</div> 199</td> 200</tr> 201</table> 202<ul class="blockList"> 203<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 204<!-- --> 205</a> 206<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 207<code><a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> 208</ul> 209</li> 210</ul> 211</li> 212</ul> 213</div> 214<div class="details"> 215<ul class="blockList"> 216<li class="blockList"> 217<!-- ========= CONSTRUCTOR DETAIL ======== --> 218<ul class="blockList"> 219<li class="blockList"><a name="constructor_detail"> 220<!-- --> 221</a> 222<h3>Constructor Detail</h3> 223<a name="Module()"> 224<!-- --> 225</a> 226<ul class="blockListLast"> 227<li class="blockList"> 228<h4>Module</h4> 229<pre>public Module()</pre> 230</li> 231</ul> 232</li> 233</ul> 234<!-- ============ METHOD DETAIL ========== --> 235<ul class="blockList"> 236<li class="blockList"><a name="method_detail"> 237<!-- --> 238</a> 239<h3>Method Detail</h3> 240<a name="getModuleName()"> 241<!-- --> 242</a> 243<ul class="blockList"> 244<li class="blockList"> 245<h4>getModuleName</h4> 246<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getModuleName()</pre> 247<div class="block">Method that returns a display that can be used by Jackson 248 for informational purposes, as well as in associating extensions with 249 module that provides them.</div> 250</li> 251</ul> 252<a name="version()"> 253<!-- --> 254</a> 255<ul class="blockList"> 256<li class="blockList"> 257<h4>version</h4> 258<pre>public abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a> version()</pre> 259<div class="block">Method that returns version of this module. Can be used by Jackson for 260 informational purposes.</div> 261<dl> 262<dt><strong>Specified by:</strong></dt> 263<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.7/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.7/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></code></dd> 264</dl> 265</li> 266</ul> 267<a name="getTypeId()"> 268<!-- --> 269</a> 270<ul class="blockList"> 271<li class="blockList"> 272<h4>getTypeId</h4> 273<pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTypeId()</pre> 274<div class="block">Method that returns an id that may be used to determine if two <a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind"><code>Module</code></a> 275 instances are considered to be of same type, for purpose of preventing 276 multiple registrations of "same type of" module 277 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 278 If `null` is returned, every instance is considered unique. 279 If non-null value is returned, equality of id Objects is used to check whether 280 modules should be considered to be "of same type" 281<p> 282 Default implementation returns value of class name (<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true#getName()" title="class or interface in java.lang"><code>Class.getName()</code></a>).</div> 283<dl><dt><span class="strong">Since:</span></dt> 284 <dd>2.5</dd></dl> 285</li> 286</ul> 287<a name="setupModule(com.fasterxml.jackson.databind.Module.SetupContext)"> 288<!-- --> 289</a> 290<ul class="blockListLast"> 291<li class="blockList"> 292<h4>setupModule</h4> 293<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> 294<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. 295 It is called to let module register functionality it provides, 296 using callback methods passed-in context object exposes.</div> 297</li> 298</ul> 299</li> 300</ul> 301</li> 302</ul> 303</div> 304</div> 305<!-- ========= END OF CLASS DATA ========= --> 306<!-- ======= START OF BOTTOM NAVBAR ====== --> 307<div class="bottomNav"><a name="navbar_bottom"> 308<!-- --> 309</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 310<!-- --> 311</a> 312<ul class="navList" title="Navigation"> 313<li><a href="../../../../overview-summary.html">Overview</a></li> 314<li><a href="package-summary.html">Package</a></li> 315<li class="navBarCell1Rev">Class</li> 316<li><a href="class-use/Module.html">Use</a></li> 317<li><a href="package-tree.html">Tree</a></li> 318<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 319<li><a href="../../../../index-all.html">Index</a></li> 320<li><a href="../../../../help-doc.html">Help</a></li> 321</ul> 322</div> 323<div class="subNav"> 324<ul class="navList"> 325<li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> 326<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> 327</ul> 328<ul class="navList"> 329<li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> 330<li><a href="Module.html" target="_top">No Frames</a></li> 331</ul> 332<ul class="navList" id="allclasses_navbar_bottom"> 333<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 334</ul> 335<div> 336<script type="text/javascript"><!-- 337 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 338 if(window==top) { 339 allClassesLink.style.display = "block"; 340 } 341 else { 342 allClassesLink.style.display = "none"; 343 } 344 //--> 345</script> 346</div> 347<div> 348<ul class="subNavList"> 349<li>Summary: </li> 350<li><a href="#nested_class_summary">Nested</a> | </li> 351<li>Field | </li> 352<li><a href="#constructor_summary">Constr</a> | </li> 353<li><a href="#method_summary">Method</a></li> 354</ul> 355<ul class="subNavList"> 356<li>Detail: </li> 357<li>Field | </li> 358<li><a href="#constructor_detail">Constr</a> | </li> 359<li><a href="#method_detail">Method</a></li> 360</ul> 361</div> 362<a name="skip-navbar_bottom"> 363<!-- --> 364</a></div> 365<!-- ======== END OF BOTTOM NAVBAR ======= --> 366<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 367</body> 368</html> 369