• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 Sun Jul 14 20:03:26 PDT 2013 -->
6<title>Module (Jackson JSON Processor)</title>
7<meta name="date" content="2013-07-14">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="Module (Jackson JSON Processor)";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/Module.html">Use</a></li>
31<li><a href="package-tree.html">Tree</a></li>
32<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
33<li><a href="../../../../index-all.html">Index</a></li>
34<li><a href="../../../../help-doc.html">Help</a></li>
35</ul>
36</div>
37<div class="subNav">
38<ul class="navList">
39<li><a href="../../../../org/codehaus/jackson/map/MappingJsonFactory.html" title="class in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li>
40<li><a href="../../../../org/codehaus/jackson/map/Module.SetupContext.html" title="interface in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/map/Module.html" target="_top">Frames</a></li>
44<li><a href="Module.html" target="_top">No Frames</a></li>
45</ul>
46<ul class="navList" id="allclasses_navbar_top">
47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
48</ul>
49<div>
50<script type="text/javascript"><!--
51  allClassesLink = document.getElementById("allclasses_navbar_top");
52  if(window==top) {
53    allClassesLink.style.display = "block";
54  }
55  else {
56    allClassesLink.style.display = "none";
57  }
58  //-->
59</script>
60</div>
61<div>
62<ul class="subNavList">
63<li>Summary:&nbsp;</li>
64<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
65<li>Field&nbsp;|&nbsp;</li>
66<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
67<li><a href="#method_summary">Method</a></li>
68</ul>
69<ul class="subNavList">
70<li>Detail:&nbsp;</li>
71<li>Field&nbsp;|&nbsp;</li>
72<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
73<li><a href="#method_detail">Method</a></li>
74</ul>
75</div>
76<a name="skip-navbar_top">
77<!--   -->
78</a></div>
79<!-- ========= END OF TOP NAVBAR ========= -->
80<!-- ======== START OF CLASS DATA ======== -->
81<div class="header">
82<div class="subTitle">org.codehaus.jackson.map</div>
83<h2 title="Class Module" class="title">Class Module</h2>
84</div>
85<div class="contentContainer">
86<ul class="inheritance">
87<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>
88<li>
89<ul class="inheritance">
90<li>org.codehaus.jackson.map.Module</li>
91</ul>
92</li>
93</ul>
94<div class="description">
95<ul class="blockList">
96<li class="blockList">
97<dl>
98<dt>All Implemented Interfaces:</dt>
99<dd><a href="../../../../org/codehaus/jackson/Versioned.html" title="interface in org.codehaus.jackson">Versioned</a></dd>
100</dl>
101<dl>
102<dt>Direct Known Subclasses:</dt>
103<dd><a href="../../../../org/codehaus/jackson/mrbean/MrBeanModule.html" title="class in org.codehaus.jackson.mrbean">MrBeanModule</a>, <a href="../../../../org/codehaus/jackson/map/module/SimpleModule.html" title="class in org.codehaus.jackson.map.module">SimpleModule</a></dd>
104</dl>
105<hr>
106<br>
107<pre>public abstract class <span class="strong">Module</span>
108extends <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>
109implements <a href="../../../../org/codehaus/jackson/Versioned.html" title="interface in org.codehaus.jackson">Versioned</a></pre>
110<div class="block">Simple interface for extensions that can be registered with <a href="../../../../org/codehaus/jackson/map/ObjectMapper.html" title="class in org.codehaus.jackson.map"><code>ObjectMapper</code></a>
111 to provide a well-defined set of extensions to default functionality; such as
112 support for new data types.</div>
113<dl><dt><span class="strong">Since:</span></dt>
114  <dd>1.7</dd></dl>
115</li>
116</ul>
117</div>
118<div class="summary">
119<ul class="blockList">
120<li class="blockList">
121<!-- ======== NESTED CLASS SUMMARY ======== -->
122<ul class="blockList">
123<li class="blockList"><a name="nested_class_summary">
124<!--   -->
125</a>
126<h3>Nested Class Summary</h3>
127<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
128<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
129<tr>
130<th class="colFirst" scope="col">Modifier and Type</th>
131<th class="colLast" scope="col">Class and Description</th>
132</tr>
133<tr class="altColor">
134<td class="colFirst"><code>static interface&nbsp;</code></td>
135<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/Module.SetupContext.html" title="interface in org.codehaus.jackson.map">Module.SetupContext</a></strong></code>
136<div class="block">Interface Jackson exposes to modules for purpose of registering
137 extended functionality.</div>
138</td>
139</tr>
140</table>
141</li>
142</ul>
143<!-- ======== CONSTRUCTOR SUMMARY ======== -->
144<ul class="blockList">
145<li class="blockList"><a name="constructor_summary">
146<!--   -->
147</a>
148<h3>Constructor Summary</h3>
149<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
150<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
151<tr>
152<th class="colOne" scope="col">Constructor and Description</th>
153</tr>
154<tr class="altColor">
155<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/map/Module.html#Module()">Module</a></strong>()</code>&nbsp;</td>
156</tr>
157</table>
158</li>
159</ul>
160<!-- ========== METHOD SUMMARY =========== -->
161<ul class="blockList">
162<li class="blockList"><a name="method_summary">
163<!--   -->
164</a>
165<h3>Method Summary</h3>
166<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
167<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
168<tr>
169<th class="colFirst" scope="col">Modifier and Type</th>
170<th class="colLast" scope="col">Method and Description</th>
171</tr>
172<tr class="altColor">
173<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>
174<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/Module.html#getModuleName()">getModuleName</a></strong>()</code>
175<div class="block">Method that returns identifier for module; this can be used by Jackson
176 for informational purposes, as well as in associating extensions with
177 module that provides them.</div>
178</td>
179</tr>
180<tr class="rowColor">
181<td class="colFirst"><code>abstract void</code></td>
182<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/Module.html#setupModule(org.codehaus.jackson.map.Module.SetupContext)">setupModule</a></strong>(<a href="../../../../org/codehaus/jackson/map/Module.SetupContext.html" title="interface in org.codehaus.jackson.map">Module.SetupContext</a>&nbsp;context)</code>
183<div class="block">Method called by <a href="../../../../org/codehaus/jackson/map/ObjectMapper.html" title="class in org.codehaus.jackson.map"><code>ObjectMapper</code></a> when module is registered.</div>
184</td>
185</tr>
186<tr class="altColor">
187<td class="colFirst"><code>abstract <a href="../../../../org/codehaus/jackson/Version.html" title="class in org.codehaus.jackson">Version</a></code></td>
188<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/map/Module.html#version()">version</a></strong>()</code>
189<div class="block">Method that returns version of this module.</div>
190</td>
191</tr>
192</table>
193<ul class="blockList">
194<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
195<!--   -->
196</a>
197<h3>Methods inherited from class&nbsp;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>
198<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>
199</ul>
200</li>
201</ul>
202</li>
203</ul>
204</div>
205<div class="details">
206<ul class="blockList">
207<li class="blockList">
208<!-- ========= CONSTRUCTOR DETAIL ======== -->
209<ul class="blockList">
210<li class="blockList"><a name="constructor_detail">
211<!--   -->
212</a>
213<h3>Constructor Detail</h3>
214<a name="Module()">
215<!--   -->
216</a>
217<ul class="blockListLast">
218<li class="blockList">
219<h4>Module</h4>
220<pre>public&nbsp;Module()</pre>
221</li>
222</ul>
223</li>
224</ul>
225<!-- ============ METHOD DETAIL ========== -->
226<ul class="blockList">
227<li class="blockList"><a name="method_detail">
228<!--   -->
229</a>
230<h3>Method Detail</h3>
231<a name="getModuleName()">
232<!--   -->
233</a>
234<ul class="blockList">
235<li class="blockList">
236<h4>getModuleName</h4>
237<pre>public abstract&nbsp;<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>&nbsp;getModuleName()</pre>
238<div class="block">Method that returns identifier for module; this can be used by Jackson
239 for informational purposes, as well as in associating extensions with
240 module that provides them.</div>
241</li>
242</ul>
243<a name="version()">
244<!--   -->
245</a>
246<ul class="blockList">
247<li class="blockList">
248<h4>version</h4>
249<pre>public abstract&nbsp;<a href="../../../../org/codehaus/jackson/Version.html" title="class in org.codehaus.jackson">Version</a>&nbsp;version()</pre>
250<div class="block">Method that returns version of this module. Can be used by Jackson for
251 informational purposes.</div>
252<dl>
253<dt><strong>Specified by:</strong></dt>
254<dd><code><a href="../../../../org/codehaus/jackson/Versioned.html#version()">version</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../org/codehaus/jackson/Versioned.html" title="interface in org.codehaus.jackson">Versioned</a></code></dd>
255</dl>
256</li>
257</ul>
258<a name="setupModule(org.codehaus.jackson.map.Module.SetupContext)">
259<!--   -->
260</a>
261<ul class="blockListLast">
262<li class="blockList">
263<h4>setupModule</h4>
264<pre>public abstract&nbsp;void&nbsp;setupModule(<a href="../../../../org/codehaus/jackson/map/Module.SetupContext.html" title="interface in org.codehaus.jackson.map">Module.SetupContext</a>&nbsp;context)</pre>
265<div class="block">Method called by <a href="../../../../org/codehaus/jackson/map/ObjectMapper.html" title="class in org.codehaus.jackson.map"><code>ObjectMapper</code></a> when module is registered.
266 It is called to let module register functionality it provides,
267 using callback methods passed-in context object exposes.</div>
268</li>
269</ul>
270</li>
271</ul>
272</li>
273</ul>
274</div>
275</div>
276<!-- ========= END OF CLASS DATA ========= -->
277<!-- ======= START OF BOTTOM NAVBAR ====== -->
278<div class="bottomNav"><a name="navbar_bottom">
279<!--   -->
280</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
281<!--   -->
282</a>
283<ul class="navList" title="Navigation">
284<li><a href="../../../../overview-summary.html">Overview</a></li>
285<li><a href="package-summary.html">Package</a></li>
286<li class="navBarCell1Rev">Class</li>
287<li><a href="class-use/Module.html">Use</a></li>
288<li><a href="package-tree.html">Tree</a></li>
289<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
290<li><a href="../../../../index-all.html">Index</a></li>
291<li><a href="../../../../help-doc.html">Help</a></li>
292</ul>
293</div>
294<div class="subNav">
295<ul class="navList">
296<li><a href="../../../../org/codehaus/jackson/map/MappingJsonFactory.html" title="class in org.codehaus.jackson.map"><span class="strong">Prev Class</span></a></li>
297<li><a href="../../../../org/codehaus/jackson/map/Module.SetupContext.html" title="interface in org.codehaus.jackson.map"><span class="strong">Next Class</span></a></li>
298</ul>
299<ul class="navList">
300<li><a href="../../../../index.html?org/codehaus/jackson/map/Module.html" target="_top">Frames</a></li>
301<li><a href="Module.html" target="_top">No Frames</a></li>
302</ul>
303<ul class="navList" id="allclasses_navbar_bottom">
304<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
305</ul>
306<div>
307<script type="text/javascript"><!--
308  allClassesLink = document.getElementById("allclasses_navbar_bottom");
309  if(window==top) {
310    allClassesLink.style.display = "block";
311  }
312  else {
313    allClassesLink.style.display = "none";
314  }
315  //-->
316</script>
317</div>
318<div>
319<ul class="subNavList">
320<li>Summary:&nbsp;</li>
321<li><a href="#nested_class_summary">Nested</a>&nbsp;|&nbsp;</li>
322<li>Field&nbsp;|&nbsp;</li>
323<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
324<li><a href="#method_summary">Method</a></li>
325</ul>
326<ul class="subNavList">
327<li>Detail:&nbsp;</li>
328<li>Field&nbsp;|&nbsp;</li>
329<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
330<li><a href="#method_detail">Method</a></li>
331</ul>
332</div>
333<a name="skip-navbar_bottom">
334<!--   -->
335</a></div>
336<!-- ======== END OF BOTTOM NAVBAR ======= -->
337</body>
338</html>
339