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 (1.8.0_162) on Tue Jan 23 20:22:12 PST 2018 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Module (jackson-databind 2.9.0 API)</title> 8<meta name="date" content="2018-01-23"> 9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> 10<script type="text/javascript" src="../../../../script.js"></script> 11</head> 12<body> 13<script type="text/javascript"><!-- 14 try { 15 if (location.href.indexOf('is-external=true') == -1) { 16 parent.document.title="Module (jackson-databind 2.9.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":6,"i1":10,"i2":6,"i3":6}; 23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]}; 24var altColor = "altColor"; 25var rowColor = "rowColor"; 26var tableTab = "tableTab"; 27var activeTableTab = "activeTableTab"; 28</script> 29<noscript> 30<div>JavaScript is disabled on your browser.</div> 31</noscript> 32<!-- ========= START OF TOP NAVBAR ======= --> 33<div class="topNav"><a name="navbar.top"> 34<!-- --> 35</a> 36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> 37<a name="navbar.top.firstrow"> 38<!-- --> 39</a> 40<ul class="navList" title="Navigation"> 41<li><a href="../../../../overview-summary.html">Overview</a></li> 42<li><a href="package-summary.html">Package</a></li> 43<li class="navBarCell1Rev">Class</li> 44<li><a href="class-use/Module.html">Use</a></li> 45<li><a href="package-tree.html">Tree</a></li> 46<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 47<li><a href="../../../../index-all.html">Index</a></li> 48<li><a href="../../../../help-doc.html">Help</a></li> 49</ul> 50</div> 51<div class="subNav"> 52<ul class="navList"> 53<li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> 58<li><a href="Module.html" target="_top">No Frames</a></li> 59</ul> 60<ul class="navList" id="allclasses_navbar_top"> 61<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 62</ul> 63<div> 64<script type="text/javascript"><!-- 65 allClassesLink = document.getElementById("allclasses_navbar_top"); 66 if(window==top) { 67 allClassesLink.style.display = "block"; 68 } 69 else { 70 allClassesLink.style.display = "none"; 71 } 72 //--> 73</script> 74</div> 75<div> 76<ul class="subNavList"> 77<li>Summary: </li> 78<li><a href="#nested.class.summary">Nested</a> | </li> 79<li>Field | </li> 80<li><a href="#constructor.summary">Constr</a> | </li> 81<li><a href="#method.summary">Method</a></li> 82</ul> 83<ul class="subNavList"> 84<li>Detail: </li> 85<li>Field | </li> 86<li><a href="#constructor.detail">Constr</a> | </li> 87<li><a href="#method.detail">Method</a></li> 88</ul> 89</div> 90<a name="skip.navbar.top"> 91<!-- --> 92</a></div> 93<!-- ========= END OF TOP NAVBAR ========= --> 94<!-- ======== START OF CLASS DATA ======== --> 95<div class="header"> 96<div class="subTitle">com.fasterxml.jackson.databind</div> 97<h2 title="Class Module" class="title">Class Module</h2> 98</div> 99<div class="contentContainer"> 100<ul class="inheritance"> 101<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> 102<li> 103<ul class="inheritance"> 104<li>com.fasterxml.jackson.databind.Module</li> 105</ul> 106</li> 107</ul> 108<div class="description"> 109<ul class="blockList"> 110<li class="blockList"> 111<dl> 112<dt>All Implemented Interfaces:</dt> 113<dd><a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></dd> 114</dl> 115<dl> 116<dt>Direct Known Subclasses:</dt> 117<dd><a href="../../../../com/fasterxml/jackson/databind/module/SimpleModule.html" title="class in com.fasterxml.jackson.databind.module">SimpleModule</a></dd> 118</dl> 119<hr> 120<br> 121<pre>public abstract class <span class="typeNameLabel">Module</span> 122extends <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> 123implements <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></pre> 124<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> 125 to provide a well-defined set of extensions to default functionality; such as 126 support for new data types.</div> 127</li> 128</ul> 129</div> 130<div class="summary"> 131<ul class="blockList"> 132<li class="blockList"> 133<!-- ======== NESTED CLASS SUMMARY ======== --> 134<ul class="blockList"> 135<li class="blockList"><a name="nested.class.summary"> 136<!-- --> 137</a> 138<h3>Nested Class Summary</h3> 139<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> 140<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> 141<tr> 142<th class="colFirst" scope="col">Modifier and Type</th> 143<th class="colLast" scope="col">Class and Description</th> 144</tr> 145<tr class="altColor"> 146<td class="colFirst"><code>static interface </code></td> 147<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a></span></code> 148<div class="block">Interface Jackson exposes to modules for purpose of registering 149 extended functionality.</div> 150</td> 151</tr> 152</table> 153</li> 154</ul> 155<!-- ======== CONSTRUCTOR SUMMARY ======== --> 156<ul class="blockList"> 157<li class="blockList"><a name="constructor.summary"> 158<!-- --> 159</a> 160<h3>Constructor Summary</h3> 161<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 162<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 163<tr> 164<th class="colOne" scope="col">Constructor and Description</th> 165</tr> 166<tr class="altColor"> 167<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#Module--">Module</a></span>()</code> </td> 168</tr> 169</table> 170</li> 171</ul> 172<!-- ========== METHOD SUMMARY =========== --> 173<ul class="blockList"> 174<li class="blockList"><a name="method.summary"> 175<!-- --> 176</a> 177<h3>Method Summary</h3> 178<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 179<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> 180<tr> 181<th class="colFirst" scope="col">Modifier and Type</th> 182<th class="colLast" scope="col">Method and Description</th> 183</tr> 184<tr id="i0" class="altColor"> 185<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> 186<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#getModuleName--">getModuleName</a></span>()</code> 187<div class="block">Method that returns a display that can be used by Jackson 188 for informational purposes, as well as in associating extensions with 189 module that provides them.</div> 190</td> 191</tr> 192<tr id="i1" class="rowColor"> 193<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> 194<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#getTypeId--">getTypeId</a></span>()</code> 195<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> 196 instances are considered to be of same type, for purpose of preventing 197 multiple registrations of "same type of" module 198 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 199 If `null` is returned, every instance is considered unique.</div> 200</td> 201</tr> 202<tr id="i2" class="altColor"> 203<td class="colFirst"><code>abstract void</code></td> 204<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#setupModule-com.fasterxml.jackson.databind.Module.SetupContext-">setupModule</a></span>(<a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a> context)</code> 205<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> 206</td> 207</tr> 208<tr id="i3" class="rowColor"> 209<td class="colFirst"><code>abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a></code></td> 210<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#version--">version</a></span>()</code> 211<div class="block">Method that returns version of this module.</div> 212</td> 213</tr> 214</table> 215<ul class="blockList"> 216<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 217<!-- --> 218</a> 219<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> 220<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-int-" title="class or interface in java.lang">wait</a></code></li> 221</ul> 222</li> 223</ul> 224</li> 225</ul> 226</div> 227<div class="details"> 228<ul class="blockList"> 229<li class="blockList"> 230<!-- ========= CONSTRUCTOR DETAIL ======== --> 231<ul class="blockList"> 232<li class="blockList"><a name="constructor.detail"> 233<!-- --> 234</a> 235<h3>Constructor Detail</h3> 236<a name="Module--"> 237<!-- --> 238</a> 239<ul class="blockListLast"> 240<li class="blockList"> 241<h4>Module</h4> 242<pre>public Module()</pre> 243</li> 244</ul> 245</li> 246</ul> 247<!-- ============ METHOD DETAIL ========== --> 248<ul class="blockList"> 249<li class="blockList"><a name="method.detail"> 250<!-- --> 251</a> 252<h3>Method Detail</h3> 253<a name="getModuleName--"> 254<!-- --> 255</a> 256<ul class="blockList"> 257<li class="blockList"> 258<h4>getModuleName</h4> 259<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> 260<div class="block">Method that returns a display that can be used by Jackson 261 for informational purposes, as well as in associating extensions with 262 module that provides them.</div> 263</li> 264</ul> 265<a name="version--"> 266<!-- --> 267</a> 268<ul class="blockList"> 269<li class="blockList"> 270<h4>version</h4> 271<pre>public abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a> version()</pre> 272<div class="block">Method that returns version of this module. Can be used by Jackson for 273 informational purposes.</div> 274<dl> 275<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 276<dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/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.9/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></code></dd> 277</dl> 278</li> 279</ul> 280<a name="getTypeId--"> 281<!-- --> 282</a> 283<ul class="blockList"> 284<li class="blockList"> 285<h4>getTypeId</h4> 286<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> 287<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> 288 instances are considered to be of same type, for purpose of preventing 289 multiple registrations of "same type of" module 290 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 291 If `null` is returned, every instance is considered unique. 292 If non-null value is returned, equality of id Objects is used to check whether 293 modules should be considered to be "of same type" 294<p> 295 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> 296<dl> 297<dt><span class="simpleTagLabel">Since:</span></dt> 298<dd>2.5</dd> 299</dl> 300</li> 301</ul> 302<a name="setupModule-com.fasterxml.jackson.databind.Module.SetupContext-"> 303<!-- --> 304</a> 305<ul class="blockListLast"> 306<li class="blockList"> 307<h4>setupModule</h4> 308<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> 309<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. 310 It is called to let module register functionality it provides, 311 using callback methods passed-in context object exposes.</div> 312</li> 313</ul> 314</li> 315</ul> 316</li> 317</ul> 318</div> 319</div> 320<!-- ========= END OF CLASS DATA ========= --> 321<!-- ======= START OF BOTTOM NAVBAR ====== --> 322<div class="bottomNav"><a name="navbar.bottom"> 323<!-- --> 324</a> 325<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 326<a name="navbar.bottom.firstrow"> 327<!-- --> 328</a> 329<ul class="navList" title="Navigation"> 330<li><a href="../../../../overview-summary.html">Overview</a></li> 331<li><a href="package-summary.html">Package</a></li> 332<li class="navBarCell1Rev">Class</li> 333<li><a href="class-use/Module.html">Use</a></li> 334<li><a href="package-tree.html">Tree</a></li> 335<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 336<li><a href="../../../../index-all.html">Index</a></li> 337<li><a href="../../../../help-doc.html">Help</a></li> 338</ul> 339</div> 340<div class="subNav"> 341<ul class="navList"> 342<li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 343<li><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 344</ul> 345<ul class="navList"> 346<li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> 347<li><a href="Module.html" target="_top">No Frames</a></li> 348</ul> 349<ul class="navList" id="allclasses_navbar_bottom"> 350<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 351</ul> 352<div> 353<script type="text/javascript"><!-- 354 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 355 if(window==top) { 356 allClassesLink.style.display = "block"; 357 } 358 else { 359 allClassesLink.style.display = "none"; 360 } 361 //--> 362</script> 363</div> 364<div> 365<ul class="subNavList"> 366<li>Summary: </li> 367<li><a href="#nested.class.summary">Nested</a> | </li> 368<li>Field | </li> 369<li><a href="#constructor.summary">Constr</a> | </li> 370<li><a href="#method.summary">Method</a></li> 371</ul> 372<ul class="subNavList"> 373<li>Detail: </li> 374<li>Field | </li> 375<li><a href="#constructor.detail">Constr</a> | </li> 376<li><a href="#method.detail">Method</a></li> 377</ul> 378</div> 379<a name="skip.navbar.bottom"> 380<!-- --> 381</a></div> 382<!-- ======== END OF BOTTOM NAVBAR ======= --> 383<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 384</body> 385</html> 386