<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_25) on Mon Jun 02 17:48:54 PDT 2014 --> <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> <title>Module (jackson-databind 2.4.0 API)</title> <meta name="date" content="2014-06-02"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="Module (jackson-databind 2.4.0 API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/Module.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> <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> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> <li><a href="Module.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.fasterxml.jackson.databind</div> <h2 title="Class Module" class="title">Class Module</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <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> <li> <ul class="inheritance"> <li>com.fasterxml.jackson.databind.Module</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="http://fasterxml.github.com/jackson-core/javadoc/2.4/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></dd> </dl> <dl> <dt>Direct Known Subclasses:</dt> <dd><a href="../../../../com/fasterxml/jackson/databind/module/SimpleModule.html" title="class in com.fasterxml.jackson.databind.module">SimpleModule</a></dd> </dl> <hr> <br> <pre>public abstract class <span class="strong">Module</span> 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> implements <a href="http://fasterxml.github.com/jackson-core/javadoc/2.4/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></pre> <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> to provide a well-defined set of extensions to default functionality; such as support for new data types.</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== NESTED CLASS SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="nested_class_summary"> <!-- --> </a> <h3>Nested Class Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Class and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static interface </code></td> <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> <div class="block">Interface Jackson exposes to modules for purpose of registering extended functionality.</div> </td> </tr> </table> </li> </ul> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#Module()">Module</a></strong>()</code> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <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> <td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#getModuleName()">getModuleName</a></strong>()</code> <div class="block">Method that returns identifier for module; this can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>abstract void</code></td> <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> <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><code>abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.4/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a></code></td> <td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/databind/Module.html#version()">version</a></strong>()</code> <div class="block">Method that returns version of this module.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <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> <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> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor_detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="Module()"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>Module</h4> <pre>public Module()</pre> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getModuleName()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getModuleName</h4> <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> <div class="block">Method that returns identifier for module; this can be used by Jackson for informational purposes, as well as in associating extensions with module that provides them.</div> </li> </ul> <a name="version()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>version</h4> <pre>public abstract <a href="http://fasterxml.github.com/jackson-core/javadoc/2.4/com/fasterxml/jackson/core/Version.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Version</a> version()</pre> <div class="block">Method that returns version of this module. Can be used by Jackson for informational purposes.</div> <dl> <dt><strong>Specified by:</strong></dt> <dd><code><a href="http://fasterxml.github.com/jackson-core/javadoc/2.4/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.4/com/fasterxml/jackson/core/Versioned.html?is-external=true" title="class or interface in com.fasterxml.jackson.core">Versioned</a></code></dd> </dl> </li> </ul> <a name="setupModule(com.fasterxml.jackson.databind.Module.SetupContext)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>setupModule</h4> <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> <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. It is called to let module register functionality it provides, using callback methods passed-in context object exposes.</div> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/Module.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../index-all.html">Index</a></li> <li><a href="../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind"><span class="strong">Prev Class</span></a></li> <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> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/Module.html" target="_top">Frames</a></li> <li><a href="Module.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li><a href="#nested_class_summary">Nested</a> | </li> <li>Field | </li> <li><a href="#constructor_summary">Constr</a> | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor_detail">Constr</a> | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2014 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved.</small></p> </body> </html>