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 Nov 05 19:39:06 PST 2019 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Module (jackson-databind 2.10.0 API)</title> 8<meta name="date" content="2019-11-05"> 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.10.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":10,"i1":6,"i2":10,"i3":6,"i4":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="https://docs.oracle.com/javase/8/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.io/jackson-core/javadoc/2.10/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="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 123implements <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/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><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends <a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind">Module</a>></code></td> 186<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#getDependencies--">getDependencies</a></span>()</code> 187<div class="block">Returns the list of dependent modules this module has, if any.</div> 188</td> 189</tr> 190<tr id="i1" class="rowColor"> 191<td class="colFirst"><code>abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 192<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#getModuleName--">getModuleName</a></span>()</code> 193<div class="block">Method that returns a display that can be used by Jackson 194 for informational purposes, as well as in associating extensions with 195 module that provides them.</div> 196</td> 197</tr> 198<tr id="i2" class="altColor"> 199<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td> 200<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#getTypeId--">getTypeId</a></span>()</code> 201<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> 202 instances are considered to be of same type, for purpose of preventing 203 multiple registrations of "same type of" module 204 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 205 If `null` is returned, every instance is considered unique.</div> 206</td> 207</tr> 208<tr id="i3" class="rowColor"> 209<td class="colFirst"><code>abstract void</code></td> 210<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> 211<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> 212</td> 213</tr> 214<tr id="i4" class="altColor"> 215<td class="colFirst"><code>abstract <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a></code></td> 216<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/Module.html#version--">version</a></span>()</code> 217<div class="block">Method that returns version of this module.</div> 218</td> 219</tr> 220</table> 221<ul class="blockList"> 222<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 223<!-- --> 224</a> 225<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 226<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> 227</ul> 228</li> 229</ul> 230</li> 231</ul> 232</div> 233<div class="details"> 234<ul class="blockList"> 235<li class="blockList"> 236<!-- ========= CONSTRUCTOR DETAIL ======== --> 237<ul class="blockList"> 238<li class="blockList"><a name="constructor.detail"> 239<!-- --> 240</a> 241<h3>Constructor Detail</h3> 242<a name="Module--"> 243<!-- --> 244</a> 245<ul class="blockListLast"> 246<li class="blockList"> 247<h4>Module</h4> 248<pre>public Module()</pre> 249</li> 250</ul> 251</li> 252</ul> 253<!-- ============ METHOD DETAIL ========== --> 254<ul class="blockList"> 255<li class="blockList"><a name="method.detail"> 256<!-- --> 257</a> 258<h3>Method Detail</h3> 259<a name="getModuleName--"> 260<!-- --> 261</a> 262<ul class="blockList"> 263<li class="blockList"> 264<h4>getModuleName</h4> 265<pre>public abstract <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getModuleName()</pre> 266<div class="block">Method that returns a display that can be used by Jackson 267 for informational purposes, as well as in associating extensions with 268 module that provides them.</div> 269</li> 270</ul> 271<a name="version--"> 272<!-- --> 273</a> 274<ul class="blockList"> 275<li class="blockList"> 276<h4>version</h4> 277<pre>public abstract <a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a> version()</pre> 278<div class="block">Method that returns version of this module. Can be used by Jackson for 279 informational purposes.</div> 280<dl> 281<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 282<dd><code><a href="http://fasterxml.github.io/jackson-core/javadoc/2.10/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.io/jackson-core/javadoc/2.10/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></code></dd> 283</dl> 284</li> 285</ul> 286<a name="getTypeId--"> 287<!-- --> 288</a> 289<ul class="blockList"> 290<li class="blockList"> 291<h4>getTypeId</h4> 292<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> getTypeId()</pre> 293<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> 294 instances are considered to be of same type, for purpose of preventing 295 multiple registrations of "same type of" module 296 (see <a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html#IGNORE_DUPLICATE_MODULE_REGISTRATIONS"><code>MapperFeature.IGNORE_DUPLICATE_MODULE_REGISTRATIONS</code></a>) 297 If `null` is returned, every instance is considered unique. 298 If non-null value is returned, equality of id Objects is used to check whether 299 modules should be considered to be "of same type" 300<p> 301 Default implementation returns value of class name (<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true#getName--" title="class or interface in java.lang"><code>Class.getName()</code></a>).</div> 302<dl> 303<dt><span class="simpleTagLabel">Since:</span></dt> 304<dd>2.5</dd> 305</dl> 306</li> 307</ul> 308<a name="setupModule-com.fasterxml.jackson.databind.Module.SetupContext-"> 309<!-- --> 310</a> 311<ul class="blockList"> 312<li class="blockList"> 313<h4>setupModule</h4> 314<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> 315<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. 316 It is called to let module register functionality it provides, 317 using callback methods passed-in context object exposes.</div> 318</li> 319</ul> 320<a name="getDependencies--"> 321<!-- --> 322</a> 323<ul class="blockListLast"> 324<li class="blockList"> 325<h4>getDependencies</h4> 326<pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends <a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind">Module</a>> getDependencies()</pre> 327<div class="block">Returns the list of dependent modules this module has, if any. 328 It is called to let modules register other modules as dependencies. 329 Modules returned will be registered before this module is registered, 330 in iteration order.</div> 331<dl> 332<dt><span class="simpleTagLabel">Since:</span></dt> 333<dd>2.10</dd> 334</dl> 335</li> 336</ul> 337</li> 338</ul> 339</li> 340</ul> 341</div> 342</div> 343<!-- ========= END OF CLASS DATA ========= --> 344<!-- ======= START OF BOTTOM NAVBAR ====== --> 345<div class="bottomNav"><a name="navbar.bottom"> 346<!-- --> 347</a> 348<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 349<a name="navbar.bottom.firstrow"> 350<!-- --> 351</a> 352<ul class="navList" title="Navigation"> 353<li><a href="../../../../overview-summary.html">Overview</a></li> 354<li><a href="package-summary.html">Package</a></li> 355<li class="navBarCell1Rev">Class</li> 356<li><a href="class-use/Module.html">Use</a></li> 357<li><a href="package-tree.html">Tree</a></li> 358<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 359<li><a href="../../../../index-all.html">Index</a></li> 360<li><a href="../../../../help-doc.html">Help</a></li> 361</ul> 362</div> 363<div class="subNav"> 364<ul class="navList"> 365<li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 366<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> 367</ul> 368<ul class="navList"> 369<li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> 370<li><a href="Module.html" target="_top">No Frames</a></li> 371</ul> 372<ul class="navList" id="allclasses_navbar_bottom"> 373<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 374</ul> 375<div> 376<script type="text/javascript"><!-- 377 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 378 if(window==top) { 379 allClassesLink.style.display = "block"; 380 } 381 else { 382 allClassesLink.style.display = "none"; 383 } 384 //--> 385</script> 386</div> 387<div> 388<ul class="subNavList"> 389<li>Summary: </li> 390<li><a href="#nested.class.summary">Nested</a> | </li> 391<li>Field | </li> 392<li><a href="#constructor.summary">Constr</a> | </li> 393<li><a href="#method.summary">Method</a></li> 394</ul> 395<ul class="subNavList"> 396<li>Detail: </li> 397<li>Field | </li> 398<li><a href="#constructor.detail">Constr</a> | </li> 399<li><a href="#method.detail">Method</a></li> 400</ul> 401</div> 402<a name="skip.navbar.bottom"> 403<!-- --> 404</a></div> 405<!-- ======== END OF BOTTOM NAVBAR ======= --> 406<p class="legalCopy"><small>Copyright © 2008–2019 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 407</body> 408</html> 409