• Home
  • 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 (1.8.0) on Sun Jul 19 11:36:54 PDT 2015 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>com.fasterxml.jackson.databind (jackson-databind 2.6.0 API)</title>
8<meta name="date" content="2015-07-19">
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="com.fasterxml.jackson.databind (jackson-databind 2.6.0 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22</script>
23<noscript>
24<div>JavaScript is disabled on your browser.</div>
25</noscript>
26<!-- ========= START OF TOP NAVBAR ======= -->
27<div class="topNav"><a name="navbar.top">
28<!--   -->
29</a>
30<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
31<a name="navbar.top.firstrow">
32<!--   -->
33</a>
34<ul class="navList" title="Navigation">
35<li><a href="../../../../overview-summary.html">Overview</a></li>
36<li class="navBarCell1Rev">Package</li>
37<li>Class</li>
38<li><a href="package-use.html">Use</a></li>
39<li><a href="package-tree.html">Tree</a></li>
40<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
41<li><a href="../../../../index-all.html">Index</a></li>
42<li><a href="../../../../help-doc.html">Help</a></li>
43</ul>
44</div>
45<div class="subNav">
46<ul class="navList">
47<li>Prev&nbsp;Package</li>
48<li><a href="../../../../com/fasterxml/jackson/databind/annotation/package-summary.html">Next&nbsp;Package</a></li>
49</ul>
50<ul class="navList">
51<li><a href="../../../../index.html?com/fasterxml/jackson/databind/package-summary.html" target="_top">Frames</a></li>
52<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
53</ul>
54<ul class="navList" id="allclasses_navbar_top">
55<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
56</ul>
57<div>
58<script type="text/javascript"><!--
59  allClassesLink = document.getElementById("allclasses_navbar_top");
60  if(window==top) {
61    allClassesLink.style.display = "block";
62  }
63  else {
64    allClassesLink.style.display = "none";
65  }
66  //-->
67</script>
68</div>
69<a name="skip.navbar.top">
70<!--   -->
71</a></div>
72<!-- ========= END OF TOP NAVBAR ========= -->
73<div class="header">
74<h1 title="Package" class="title">Package&nbsp;com.fasterxml.jackson.databind</h1>
75<div class="docSummary">
76<div class="block">Basic data binding (mapping) functionality that
77allows for reading JSON content into Java Objects (POJOs)
78and JSON Trees (<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as
79writing Java Objects and trees as JSON.</div>
80</div>
81<p>See:&nbsp;<a href="#package.description">Description</a></p>
82</div>
83<div class="contentContainer">
84<ul class="blockList">
85<li class="blockList">
86<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
87<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
88<tr>
89<th class="colFirst" scope="col">Interface</th>
90<th class="colLast" scope="col">Description</th>
91</tr>
92<tbody>
93<tr class="altColor">
94<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></td>
95<td class="colLast">
96<div class="block">Bean properties are logical entities that represent data
97 that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans")
98 contain; and that are accessed using accessors (methods like getters
99 and setters, fields, constructor parametrers).</div>
100</td>
101</tr>
102<tr class="rowColor">
103<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></td>
104<td class="colLast">
105<div class="block">Interface that can be implemented by objects that know how to
106 serialize themselves to JSON, using <code>JsonGenerator</code>
107 (and <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a> if necessary).</div>
108</td>
109</tr>
110<tr class="altColor">
111<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a></td>
112<td class="colLast">
113<div class="block">Interface Jackson exposes to modules for purpose of registering
114 extended functionality.</div>
115</td>
116</tr>
117</tbody>
118</table>
119</li>
120<li class="blockList">
121<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
122<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
123<tr>
124<th class="colFirst" scope="col">Class</th>
125<th class="colLast" scope="col">Description</th>
126</tr>
127<tbody>
128<tr class="altColor">
129<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AbstractTypeResolver.html" title="class in com.fasterxml.jackson.databind">AbstractTypeResolver</a></td>
130<td class="colLast">
131<div class="block">Defines interface for resolvers that can resolve abstract types into concrete
132 ones; either by using static mappings, or possibly by materializing
133 implementations dynamically.</div>
134</td>
135</tr>
136<tr class="rowColor">
137<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a></td>
138<td class="colLast">
139<div class="block">Abstract class that defines API used for introspecting annotation-based
140 configuration for serialization and deserialization.</div>
141</td>
142</tr>
143<tr class="altColor">
144<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</a></td>
145<td class="colLast">
146<div class="block">Value type used with managed and back references; contains type and
147 logic name, used to link related references</div>
148</td>
149</tr>
150<tr class="rowColor">
151<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind">BeanDescription</a></td>
152<td class="colLast">
153<div class="block">Basic container for information gathered by <a href="../../../../com/fasterxml/jackson/databind/introspect/ClassIntrospector.html" title="class in com.fasterxml.jackson.databind.introspect"><code>ClassIntrospector</code></a> to
154 help in constructing serializers and deserializers.</div>
155</td>
156</tr>
157<tr class="altColor">
158<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></td>
159<td class="colLast">
160<div class="block">Simple stand-alone implementation, useful as a placeholder
161 or base class for more complex implementations.</div>
162</td>
163</tr>
164<tr class="rowColor">
165<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.html" title="class in com.fasterxml.jackson.databind">DatabindContext</a></td>
166<td class="colLast">
167<div class="block">Shared base class for <a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind"><code>DeserializationContext</code></a> and
168 <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a>, context objects passed through data-binding
169 process.</div>
170</td>
171</tr>
172<tr class="altColor">
173<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationConfig.html" title="class in com.fasterxml.jackson.databind">DeserializationConfig</a></td>
174<td class="colLast">
175<div class="block">Object that contains baseline configuration for deserialization
176 process.</div>
177</td>
178</tr>
179<tr class="rowColor">
180<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a></td>
181<td class="colLast">
182<div class="block">Context for the process of deserialization a single root-level value.</div>
183</td>
184</tr>
185<tr class="altColor">
186<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.html" title="class in com.fasterxml.jackson.databind">InjectableValues</a></td>
187<td class="colLast">
188<div class="block">Abstract class that defines API for objects that provide value to
189 "inject" during deserialization.</div>
190</td>
191</tr>
192<tr class="rowColor">
193<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind">InjectableValues.Std</a></td>
194<td class="colLast">
195<div class="block">Simple standard implementation which uses a simple Map to
196 store values to inject, identified by simple String keys.</div>
197</td>
198</tr>
199<tr class="altColor">
200<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></td>
201<td class="colLast">
202<div class="block">Base class for type token classes used both to contain information
203 and as keys for deserializers.</div>
204</td>
205</tr>
206<tr class="rowColor">
207<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a>&lt;T&gt;</td>
208<td class="colLast">
209<div class="block">Abstract class that defines API used by <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (and
210 other chained <a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonDeserializer</code></a>s too) to deserialize Objects of
211 arbitrary types from JSON, using provided <code>JsonParser</code>.</div>
212</td>
213</tr>
214<tr class="altColor">
215<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer.None</a></td>
216<td class="colLast">
217<div class="block">This marker class is only to be used with annotations, to
218 indicate that <b>no deserializer is configured</b>.</div>
219</td>
220</tr>
221<tr class="rowColor">
222<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.Reference.html" title="class in com.fasterxml.jackson.databind">JsonMappingException.Reference</a></td>
223<td class="colLast">
224<div class="block">Simple bean class used to contain references.</div>
225</td>
226</tr>
227<tr class="altColor">
228<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</a></td>
229<td class="colLast">
230<div class="block">Base class for all JSON nodes, which form the basis of JSON
231 Tree Model that Jackson implements.</div>
232</td>
233</tr>
234<tr class="rowColor">
235<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.Base.html" title="class in com.fasterxml.jackson.databind">JsonSerializable.Base</a></td>
236<td class="colLast">
237<div class="block">Base class with minimal implementation, as well as couple of extension methods
238 that core Jackson databinding makes use of.</div>
239</td>
240</tr>
241<tr class="altColor">
242<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind">JsonSerializer</a>&lt;T&gt;</td>
243<td class="colLast">
244<div class="block">Abstract class that defines API used by <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (and
245 other chained <a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a>s too) to serialize Objects of
246 arbitrary types into JSON, using provided <code>JsonGenerator</code>.</div>
247</td>
248</tr>
249<tr class="rowColor">
250<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind">JsonSerializer.None</a></td>
251<td class="colLast">
252<div class="block">This marker class is only to be used with annotations, to
253 indicate that <b>no serializer is configured</b>.</div>
254</td>
255</tr>
256<tr class="altColor">
257<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer</a></td>
258<td class="colLast">
259<div class="block">Abstract class that defines API used for deserializing JSON content
260 field names into Java Map keys.</div>
261</td>
262</tr>
263<tr class="rowColor">
264<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</a></td>
265<td class="colLast">
266<div class="block">This marker class is only to be used with annotations, to
267 indicate that <b>no deserializer is configured</b>.</div>
268</td>
269</tr>
270<tr class="altColor">
271<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MappingIterator.html" title="class in com.fasterxml.jackson.databind">MappingIterator</a>&lt;T&gt;</td>
272<td class="colLast">
273<div class="block">Iterator exposed by <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> when binding sequence of
274 objects.</div>
275</td>
276</tr>
277<tr class="rowColor">
278<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind">MappingJsonFactory</a></td>
279<td class="colLast">
280<div class="block">Sub-class of <code>JsonFactory</code> that will create a proper
281 <code>ObjectCodec</code> to allow seam-less conversions between
282 JSON content and Java objects (POJOs).</div>
283</td>
284</tr>
285<tr class="altColor">
286<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind">Module</a></td>
287<td class="colLast">
288<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>
289 to provide a well-defined set of extensions to default functionality; such as
290 support for new data types.</div>
291</td>
292</tr>
293<tr class="rowColor">
294<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind">ObjectMapper</a></td>
295<td class="colLast">
296<div class="block">ObjectMapper provides functionality for reading and writing JSON,
297 either to and from basic POJOs (Plain Old Java Objects), or to and from
298 a general-purpose JSON Tree Model (<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as
299 related functionality for performing conversions.</div>
300</td>
301</tr>
302<tr class="altColor">
303<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.DefaultTypeResolverBuilder.html" title="class in com.fasterxml.jackson.databind">ObjectMapper.DefaultTypeResolverBuilder</a></td>
304<td class="colLast">
305<div class="block">Customized <a href="../../../../com/fasterxml/jackson/databind/jsontype/TypeResolverBuilder.html" title="interface in com.fasterxml.jackson.databind.jsontype"><code>TypeResolverBuilder</code></a> that provides type resolver builders
306 used with so-called "default typing"
307 (see <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#enableDefaultTyping--"><code>ObjectMapper.enableDefaultTyping()</code></a> for details).</div>
308</td>
309</tr>
310<tr class="rowColor">
311<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind">ObjectReader</a></td>
312<td class="colLast">
313<div class="block">Builder object that can be used for per-serialization configuration of
314 deserialization parameters, such as root type to use or object
315 to update (instead of constructing new instance).</div>
316</td>
317</tr>
318<tr class="altColor">
319<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind">ObjectWriter</a></td>
320<td class="colLast">
321<div class="block">Builder object that can be used for per-serialization configuration of
322 serialization parameters, such as JSON View and root type to use.</div>
323</td>
324</tr>
325<tr class="rowColor">
326<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.GeneratorSettings.html" title="class in com.fasterxml.jackson.databind">ObjectWriter.GeneratorSettings</a></td>
327<td class="colLast">
328<div class="block">Helper class used for containing settings specifically related
329 to (re)configuring <code>JsonGenerator</code> constructed for
330 writing output.</div>
331</td>
332</tr>
333<tr class="altColor">
334<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.Prefetch.html" title="class in com.fasterxml.jackson.databind">ObjectWriter.Prefetch</a></td>
335<td class="colLast">
336<div class="block">As a minor optimization, we will make an effort to pre-fetch a serializer,
337 or at least relevant <code>TypeSerializer</code>, if given enough
338 information.</div>
339</td>
340</tr>
341<tr class="rowColor">
342<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></td>
343<td class="colLast">
344<div class="block">Simple container class used for storing "additional" metadata about
345 properties.</div>
346</td>
347</tr>
348<tr class="altColor">
349<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></td>
350<td class="colLast">
351<div class="block">Simple value class used for containing names of properties as defined
352 by annotations (and possibly other configuration sources).</div>
353</td>
354</tr>
355<tr class="rowColor">
356<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy</a></td>
357<td class="colLast">
358<div class="block">Class that defines how names of JSON properties ("external names")
359 are derived from names of POJO methods and fields ("internal names"),
360 in cases where they are not
361 auto-detected and no explicit annotations exist for naming.</div>
362</td>
363</tr>
364<tr class="altColor">
365<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.LowerCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.LowerCaseStrategy</a></td>
366<td class="colLast">
367<div class="block">Simple strategy where external name simply only uses lower-case characters,
368 and no separators.</div>
369</td>
370</tr>
371<tr class="rowColor">
372<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy</a></td>
373<td class="colLast">
374<div class="block">A <a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.html" title="class in com.fasterxml.jackson.databind"><code>PropertyNamingStrategy</code></a> that translates typical camel case Java
375 property names to lower case JSON element names, separated by
376 underscores.</div>
377</td>
378</tr>
379<tr class="altColor">
380<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.PascalCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.PascalCaseStrategy</a></td>
381<td class="colLast">
382<div class="block">A <a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.html" title="class in com.fasterxml.jackson.databind"><code>PropertyNamingStrategy</code></a> that translates typical camelCase Java
383 property names to PascalCase JSON element names (i.e., with a capital
384 first letter).</div>
385</td>
386</tr>
387<tr class="rowColor">
388<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.PropertyNamingStrategyBase.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.PropertyNamingStrategyBase</a></td>
389<td class="colLast">&nbsp;</td>
390</tr>
391<tr class="altColor">
392<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SequenceWriter.html" title="class in com.fasterxml.jackson.databind">SequenceWriter</a></td>
393<td class="colLast">
394<div class="block">Writer class similar to <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>, except that it can be used
395 for writing sequences of values, not just a single value.</div>
396</td>
397</tr>
398<tr class="rowColor">
399<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializationConfig.html" title="class in com.fasterxml.jackson.databind">SerializationConfig</a></td>
400<td class="colLast">
401<div class="block">Object that contains baseline configuration for serialization
402 process.</div>
403</td>
404</tr>
405<tr class="altColor">
406<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a></td>
407<td class="colLast">
408<div class="block">Class that defines API used by <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> and
409 <a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a>s to obtain serializers capable of serializing
410 instances of specific types; as well as the default implementation
411 of the functionality.</div>
412</td>
413</tr>
414</tbody>
415</table>
416</li>
417<li class="blockList">
418<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation">
419<caption><span>Enum Summary</span><span class="tabEnd">&nbsp;</span></caption>
420<tr>
421<th class="colFirst" scope="col">Enum</th>
422<th class="colLast" scope="col">Description</th>
423</tr>
424<tbody>
425<tr class="altColor">
426<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.Type.html" title="enum in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty.Type</a></td>
427<td class="colLast">&nbsp;</td>
428</tr>
429<tr class="rowColor">
430<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationFeature.html" title="enum in com.fasterxml.jackson.databind">DeserializationFeature</a></td>
431<td class="colLast">
432<div class="block">Enumeration that defines simple on/off features that affect
433 the way Java objects are deserialized from JSON</div>
434</td>
435</tr>
436<tr class="altColor">
437<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</a></td>
438<td class="colLast">
439<div class="block">Enumeration that defines simple on/off features to set
440 for <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>, and accessible (but not changeable)
441 via <a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind"><code>ObjectReader</code></a> and <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> (as well as
442 through various convenience methods through context objects).</div>
443</td>
444</tr>
445<tr class="rowColor">
446<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.DefaultTyping.html" title="enum in com.fasterxml.jackson.databind">ObjectMapper.DefaultTyping</a></td>
447<td class="colLast">
448<div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#enableDefaultTyping--"><code>ObjectMapper.enableDefaultTyping()</code></a>
449 to specify what kind of types (classes) default typing should
450 be used for.</div>
451</td>
452</tr>
453<tr class="altColor">
454<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a></td>
455<td class="colLast">
456<div class="block">Enumeration that defines simple on/off features that affect
457 the way Java objects are serialized.</div>
458</td>
459</tr>
460</tbody>
461</table>
462</li>
463<li class="blockList">
464<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation">
465<caption><span>Exception Summary</span><span class="tabEnd">&nbsp;</span></caption>
466<tr>
467<th class="colFirst" scope="col">Exception</th>
468<th class="colLast" scope="col">Description</th>
469</tr>
470<tbody>
471<tr class="altColor">
472<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></td>
473<td class="colLast">
474<div class="block">Checked exception used to signal fatal problems with mapping of
475 content.</div>
476</td>
477</tr>
478<tr class="rowColor">
479<td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/RuntimeJsonMappingException.html" title="class in com.fasterxml.jackson.databind">RuntimeJsonMappingException</a></td>
480<td class="colLast">
481<div class="block">Wrapper used when interface does not allow throwing a checked
482 <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind"><code>JsonMappingException</code></a></div>
483</td>
484</tr>
485</tbody>
486</table>
487</li>
488</ul>
489<a name="package.description">
490<!--   -->
491</a>
492<h2 title="Package com.fasterxml.jackson.databind Description">Package com.fasterxml.jackson.databind Description</h2>
493<div class="block">Basic data binding (mapping) functionality that
494allows for reading JSON content into Java Objects (POJOs)
495and JSON Trees (<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as
496writing Java Objects and trees as JSON.
497Reading and writing (as well as related additional functionality) is accessed through
498<a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>,
499<a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind"><code>ObjectReader</code></a> and
500<a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>
501 classes.
502 In addition to reading and writing JSON content, it is also possible to use the
503 general databinding functionality for many other data formats, using
504 Jackson extension modules that provide such support: if so, you typically
505 simply construct an <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> with
506 different underlying streaming parser, generator implementation.
507<p>
508The main starting point for operations is <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>,
509which can be used either directly (via multiple overloaded
510<code>readValue</code>,
511<code>readTree</code>,
512<code>writeValue</code> and
513<code>writeTree</code> methods, or it can be used as a configurable factory for constructing
514fully immutable, thread-safe and reusable <a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind"><code>ObjectReader</code></a>
515and <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> objects.
516<p>
517In addition to simple reading and writing of JSON as POJOs or JSON trees (represented as
518<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>, and configurability needed to change aspects
519of reading/writing, mapper contains additional functionality such as:
520<ul>
521 <li>Value conversions using <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#convertValue-java.lang.Object-java.lang.Class-"><code>ObjectMapper.convertValue(Object, Class)</code></a>,
522  <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#valueToTree-java.lang.Object-"><code>ObjectMapper.valueToTree(Object)</code></a> and
523  <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#treeToValue-com.fasterxml.jackson.core.TreeNode-java.lang.Class-"><code>ObjectMapper.treeToValue(com.fasterxml.jackson.core.TreeNode, Class)</code></a> methods.
524  </li>
525 <li>Type introspection needed for things like generation of Schemas (like JSON Schema, Avro Schema, or protoc
526   definitions), using <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#acceptJsonFormatVisitor-java.lang.Class-com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper-"><code>ObjectMapper.acceptJsonFormatVisitor(Class, com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitorWrapper)</code></a>
527   (note: actual handles are usually provided by various Jackson modules: mapper simply initiates calling of
528   callbacks, based on serializers registered)
529  </li>
530</ul>
531<p>
532Simplest usage is of form:
533<pre>
534  final ObjectMapper mapper = new ObjectMapper(); // can use static singleton, inject: just make sure to reuse!
535  MyValue value = new MyValue();
536  // ... and configure
537  File newState = new File("my-stuff.json");
538  mapper.writeValue(newState, value); // writes JSON serialization of MyValue instance
539  // or, read
540  MyValue older = mapper.readValue(new File("my-older-stuff.json"), MyValue.class);
541
542  // Or if you prefer JSON Tree representation:
543  JsonNode root = mapper.readTree(newState);
544  // and find values by, for example, using a <code>JsonPointer</code> expression:
545  int age = root.at("/personal/age").getValueAsInt();
546</pre>
547<p>
548For more usage, refer to
549<a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>,
550<a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind"><code>ObjectReader</code></a> and
551<a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>
552Javadocs.</div>
553</div>
554<!-- ======= START OF BOTTOM NAVBAR ====== -->
555<div class="bottomNav"><a name="navbar.bottom">
556<!--   -->
557</a>
558<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
559<a name="navbar.bottom.firstrow">
560<!--   -->
561</a>
562<ul class="navList" title="Navigation">
563<li><a href="../../../../overview-summary.html">Overview</a></li>
564<li class="navBarCell1Rev">Package</li>
565<li>Class</li>
566<li><a href="package-use.html">Use</a></li>
567<li><a href="package-tree.html">Tree</a></li>
568<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
569<li><a href="../../../../index-all.html">Index</a></li>
570<li><a href="../../../../help-doc.html">Help</a></li>
571</ul>
572</div>
573<div class="subNav">
574<ul class="navList">
575<li>Prev&nbsp;Package</li>
576<li><a href="../../../../com/fasterxml/jackson/databind/annotation/package-summary.html">Next&nbsp;Package</a></li>
577</ul>
578<ul class="navList">
579<li><a href="../../../../index.html?com/fasterxml/jackson/databind/package-summary.html" target="_top">Frames</a></li>
580<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
581</ul>
582<ul class="navList" id="allclasses_navbar_bottom">
583<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
584</ul>
585<div>
586<script type="text/javascript"><!--
587  allClassesLink = document.getElementById("allclasses_navbar_bottom");
588  if(window==top) {
589    allClassesLink.style.display = "block";
590  }
591  else {
592    allClassesLink.style.display = "none";
593  }
594  //-->
595</script>
596</div>
597<a name="skip.navbar.bottom">
598<!--   -->
599</a></div>
600<!-- ======== END OF BOTTOM NAVBAR ======= -->
601<p class="legalCopy"><small>Copyright &#169; 2014&#x2013;2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
602</body>
603</html>
604