<!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 (1.8.0_162) on Tue Jan 23 20:22:17 PST 2018 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>com.fasterxml.jackson.databind (jackson-databind 2.9.0 API)</title> <meta name="date" content="2018-01-23"> <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="com.fasterxml.jackson.databind (jackson-databind 2.9.0 API)"; } } catch(err) { } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li class="navBarCell1Rev">Package</li> <li>Class</li> <li><a href="package-use.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>Prev Package</li> <li><a href="../../../../com/fasterxml/jackson/databind/annotation/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.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> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <div class="header"> <h1 title="Package" class="title">Package com.fasterxml.jackson.databind</h1> <div class="docSummary"> <div class="block">Basic data binding (mapping) functionality that allows for reading JSON content into Java Objects (POJOs) and JSON Trees (<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as writing Java Objects and trees as JSON.</div> </div> <p>See: <a href="#package.description">Description</a></p> </div> <div class="contentContainer"> <ul class="blockList"> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation"> <caption><span>Interface Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Interface</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind">BeanProperty</a></td> <td class="colLast"> <div class="block">Bean properties are logical entities that represent data that Java objects (POJOs (Plain Old Java Objects), sometimes also called "beans") contain; and that are accessed using accessors (methods like getters and setters, fields, constructor parameters).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></td> <td class="colLast"> <div class="block">Interface that can be implemented by objects that know how to serialize themselves to JSON, using <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator</code></a> (and <a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a> if necessary).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/Module.SetupContext.html" title="interface in com.fasterxml.jackson.databind">Module.SetupContext</a></td> <td class="colLast"> <div class="block">Interface Jackson exposes to modules for purpose of registering extended functionality.</div> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation"> <caption><span>Class Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Class</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AbstractTypeResolver.html" title="class in com.fasterxml.jackson.databind">AbstractTypeResolver</a></td> <td class="colLast"> <div class="block">Defines interface for resolvers that can resolve abstract types into concrete ones; either by using static mappings, or possibly by materializing implementations dynamically.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector</a></td> <td class="colLast"> <div class="block">Abstract class that defines API used for introspecting annotation-based configuration for serialization and deserialization.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/AnnotationIntrospector.ReferenceProperty.html" title="class in com.fasterxml.jackson.databind">AnnotationIntrospector.ReferenceProperty</a></td> <td class="colLast"> <div class="block">Value type used with managed and back references; contains type and logic name, used to link related references</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanDescription.html" title="class in com.fasterxml.jackson.databind">BeanDescription</a></td> <td class="colLast"> <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 help in constructing serializers and deserializers.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Bogus.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Bogus</a></td> <td class="colLast"> <div class="block">Alternative "Null" implementation that can be used in cases where a non-null <a href="../../../../com/fasterxml/jackson/databind/BeanProperty.html" title="interface in com.fasterxml.jackson.databind"><code>BeanProperty</code></a> is needed</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/BeanProperty.Std.html" title="class in com.fasterxml.jackson.databind">BeanProperty.Std</a></td> <td class="colLast"> <div class="block">Simple stand-alone implementation, useful as a placeholder or base class for more complex implementations.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DatabindContext.html" title="class in com.fasterxml.jackson.databind">DatabindContext</a></td> <td class="colLast"> <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 <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 process.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationConfig.html" title="class in com.fasterxml.jackson.databind">DeserializationConfig</a></td> <td class="colLast"> <div class="block">Object that contains baseline configuration for deserialization process.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationContext.html" title="class in com.fasterxml.jackson.databind">DeserializationContext</a></td> <td class="colLast"> <div class="block">Context for the process of deserialization a single root-level value.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.html" title="class in com.fasterxml.jackson.databind">InjectableValues</a></td> <td class="colLast"> <div class="block">Abstract class that defines API for objects that provide value to "inject" during deserialization.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/InjectableValues.Std.html" title="class in com.fasterxml.jackson.databind">InjectableValues.Std</a></td> <td class="colLast"> <div class="block">Simple standard implementation which uses a simple Map to store values to inject, identified by simple String keys.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JavaType.html" title="class in com.fasterxml.jackson.databind">JavaType</a></td> <td class="colLast"> <div class="block">Base class for type token classes used both to contain information and as keys for deserializers.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer</a><T></td> <td class="colLast"> <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 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 arbitrary types from JSON, using provided <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonParser.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonParser</code></a>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonDeserializer.None.html" title="class in com.fasterxml.jackson.databind">JsonDeserializer.None</a></td> <td class="colLast"> <div class="block">This marker class is only to be used with annotations, to indicate that <b>no deserializer is configured</b>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.Reference.html" title="class in com.fasterxml.jackson.databind">JsonMappingException.Reference</a></td> <td class="colLast"> <div class="block">Simple bean class used to contain references.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</a></td> <td class="colLast"> <div class="block">Base class for all JSON nodes, which form the basis of JSON Tree Model that Jackson implements.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.Base.html" title="class in com.fasterxml.jackson.databind">JsonSerializable.Base</a></td> <td class="colLast"> <div class="block">Base class with minimal implementation, as well as couple of extension methods that core Jackson databinding makes use of.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind">JsonSerializer</a><T></td> <td class="colLast"> <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 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 arbitrary types into JSON, using provided <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator</code></a>.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.None.html" title="class in com.fasterxml.jackson.databind">JsonSerializer.None</a></td> <td class="colLast"> <div class="block">This marker class is only to be used with annotations, to indicate that <b>no serializer is configured</b>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer</a></td> <td class="colLast"> <div class="block">Abstract class that defines API used for deserializing JSON content field names into Java Map keys.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/KeyDeserializer.None.html" title="class in com.fasterxml.jackson.databind">KeyDeserializer.None</a></td> <td class="colLast"> <div class="block">This marker class is only to be used with annotations, to indicate that <b>no deserializer is configured</b>.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MappingIterator.html" title="class in com.fasterxml.jackson.databind">MappingIterator</a><T></td> <td class="colLast"> <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 objects.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MappingJsonFactory.html" title="class in com.fasterxml.jackson.databind">MappingJsonFactory</a></td> <td class="colLast"> <div class="block">Sub-class of <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonFactory.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonFactory</code></a> that will create a proper <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/ObjectCodec.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>ObjectCodec</code></a> to allow seam-less conversions between JSON content and Java objects (POJOs).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/Module.html" title="class in com.fasterxml.jackson.databind">Module</a></td> <td class="colLast"> <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> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind">ObjectMapper</a></td> <td class="colLast"> <div class="block">ObjectMapper provides functionality for reading and writing JSON, either to and from basic POJOs (Plain Old Java Objects), or to and from 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 related functionality for performing conversions.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.DefaultTypeResolverBuilder.html" title="class in com.fasterxml.jackson.databind">ObjectMapper.DefaultTypeResolverBuilder</a></td> <td class="colLast"> <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 used with so-called "default typing" (see <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#enableDefaultTyping--"><code>ObjectMapper.enableDefaultTyping()</code></a> for details).</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectReader.html" title="class in com.fasterxml.jackson.databind">ObjectReader</a></td> <td class="colLast"> <div class="block">Builder object that can be used for per-serialization configuration of deserialization parameters, such as root type to use or object to update (instead of constructing new instance).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind">ObjectWriter</a></td> <td class="colLast"> <div class="block">Builder object that can be used for per-serialization configuration of serialization parameters, such as JSON View and root type to use.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.GeneratorSettings.html" title="class in com.fasterxml.jackson.databind">ObjectWriter.GeneratorSettings</a></td> <td class="colLast"> <div class="block">Helper class used for containing settings specifically related to (re)configuring <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator</code></a> constructed for writing output.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.Prefetch.html" title="class in com.fasterxml.jackson.databind">ObjectWriter.Prefetch</a></td> <td class="colLast"> <div class="block">As a minor optimization, we will make an effort to pre-fetch a serializer, or at least relevant <code>TypeSerializer</code>, if given enough information.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata</a></td> <td class="colLast"> <div class="block">Simple container class used for storing "additional" metadata about properties.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyMetadata.MergeInfo.html" title="class in com.fasterxml.jackson.databind">PropertyMetadata.MergeInfo</a></td> <td class="colLast"> <div class="block">Helper class used for containing information about expected merge information for this property, if merging is expected.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyName.html" title="class in com.fasterxml.jackson.databind">PropertyName</a></td> <td class="colLast"> <div class="block">Simple value class used for containing names of properties as defined by annotations (and possibly other configuration sources).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy</a></td> <td class="colLast"> <div class="block">Class that defines how names of JSON properties ("external names") are derived from names of POJO methods and fields ("internal names"), in cases where they are not auto-detected and no explicit annotations exist for naming.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.KebabCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.KebabCaseStrategy</a></td> <td class="colLast"> <div class="block">Naming strategy similar to <a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.SnakeCaseStrategy.html" title="class in com.fasterxml.jackson.databind"><code>PropertyNamingStrategy.SnakeCaseStrategy</code></a>, but instead of underscores as separators, uses hyphens.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.LowerCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.LowerCaseStrategy</a></td> <td class="colLast"> <div class="block">Simple strategy where external name simply only uses lower-case characters, and no separators.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.LowerCaseWithUnderscoresStrategy</a></td> <td class="colLast">Deprecated <div class="block"><span class="deprecationComment">In 2.7 use <a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.SnakeCaseStrategy.html" title="class in com.fasterxml.jackson.databind"><code>PropertyNamingStrategy.SnakeCaseStrategy</code></a> instead</span></div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.PascalCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.PascalCaseStrategy</a></td> <td class="colLast">Deprecated <div class="block"><span class="deprecationComment">In 2.7 use <a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.UpperCamelCaseStrategy.html" title="class in com.fasterxml.jackson.databind"><code>PropertyNamingStrategy.UpperCamelCaseStrategy</code></a> instead</span></div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.PropertyNamingStrategyBase.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.PropertyNamingStrategyBase</a></td> <td class="colLast"> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.SnakeCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.SnakeCaseStrategy</a></td> <td class="colLast"> <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 property names to lower case JSON element names, separated by underscores.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/PropertyNamingStrategy.UpperCamelCaseStrategy.html" title="class in com.fasterxml.jackson.databind">PropertyNamingStrategy.UpperCamelCaseStrategy</a></td> <td class="colLast"> <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 property names to PascalCase JSON element names (i.e., with a capital first letter).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SequenceWriter.html" title="class in com.fasterxml.jackson.databind">SequenceWriter</a></td> <td class="colLast"> <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 for writing sequences of values, not just a single value.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializationConfig.html" title="class in com.fasterxml.jackson.databind">SerializationConfig</a></td> <td class="colLast"> <div class="block">Object that contains baseline configuration for serialization process.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a></td> <td class="colLast"> <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 <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 instances of specific types; as well as the default implementation of the functionality.</div> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Summary table, listing enums, and an explanation"> <caption><span>Enum Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Enum</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <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> <td class="colLast"> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/DeserializationFeature.html" title="enum in com.fasterxml.jackson.databind">DeserializationFeature</a></td> <td class="colLast"> <div class="block">Enumeration that defines simple on/off features that affect the way Java objects are deserialized from JSON</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/MapperFeature.html" title="enum in com.fasterxml.jackson.databind">MapperFeature</a></td> <td class="colLast"> <div class="block">Enumeration that defines simple on/off features to set 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) 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 through various convenience methods through context objects).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.DefaultTyping.html" title="enum in com.fasterxml.jackson.databind">ObjectMapper.DefaultTyping</a></td> <td class="colLast"> <div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#enableDefaultTyping--"><code>ObjectMapper.enableDefaultTyping()</code></a> to specify what kind of types (classes) default typing should be used for.</div> </td> </tr> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a></td> <td class="colLast"> <div class="block">Enumeration that defines simple on/off features that affect the way Java objects are serialized.</div> </td> </tr> </tbody> </table> </li> <li class="blockList"> <table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Exception Summary table, listing exceptions, and an explanation"> <caption><span>Exception Summary</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Exception</th> <th class="colLast" scope="col">Description</th> </tr> <tbody> <tr class="altColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind">JsonMappingException</a></td> <td class="colLast"> <div class="block">Checked exception used to signal fatal problems with mapping of content, distinct from low-level I/O problems (signaled using simple <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io"><code>IOException</code></a>s) or data encoding/decoding problems (signaled with <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonParseException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonParseException</code></a>, <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerationException.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerationException</code></a>).</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><a href="../../../../com/fasterxml/jackson/databind/RuntimeJsonMappingException.html" title="class in com.fasterxml.jackson.databind">RuntimeJsonMappingException</a></td> <td class="colLast"> <div class="block">Wrapper used when interface does not allow throwing a checked <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind"><code>JsonMappingException</code></a></div> </td> </tr> </tbody> </table> </li> </ul> <a name="package.description"> <!-- --> </a> <h2 title="Package com.fasterxml.jackson.databind Description">Package com.fasterxml.jackson.databind Description</h2> <div class="block">Basic data binding (mapping) functionality that allows for reading JSON content into Java Objects (POJOs) and JSON Trees (<a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind"><code>JsonNode</code></a>), as well as writing Java Objects and trees as JSON. Reading and writing (as well as related additional functionality) is accessed through <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>, <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> classes. In addition to reading and writing JSON content, it is also possible to use the general databinding functionality for many other data formats, using Jackson extension modules that provide such support: if so, you typically simply construct an <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> with different underlying streaming parser, generator implementation. <p> The 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>, which can be used either directly (via multiple overloaded <code>readValue</code>, <code>readTree</code>, <code>writeValue</code> and <code>writeTree</code> methods, or it can be used as a configurable factory for constructing fully immutable, thread-safe and reusable <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> objects. <p> In addition to simple reading and writing of JSON as POJOs or JSON trees (represented as <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 of reading/writing, mapper contains additional functionality such as: <ul> <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>, <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#valueToTree-java.lang.Object-"><code>ObjectMapper.valueToTree(Object)</code></a> and <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. </li> <li>Type introspection needed for things like generation of Schemas (like JSON Schema, Avro Schema, or protoc 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> (note: actual handles are usually provided by various Jackson modules: mapper simply initiates calling of callbacks, based on serializers registered) </li> </ul> <p> Simplest usage is of form: <pre> final ObjectMapper mapper = new ObjectMapper(); // can use static singleton, inject: just make sure to reuse! MyValue value = new MyValue(); // ... and configure File newState = new File("my-stuff.json"); mapper.writeValue(newState, value); // writes JSON serialization of MyValue instance // or, read MyValue older = mapper.readValue(new File("my-older-stuff.json"), MyValue.class); // Or if you prefer JSON Tree representation: JsonNode root = mapper.readTree(newState); // and find values by, for example, using a <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonPointer.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>JsonPointer</code></a> expression: int age = root.at("/personal/age").getValueAsInt(); </pre> <p> For more usage, refer to <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>, <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> Javadocs.</div> </div> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../overview-summary.html">Overview</a></li> <li class="navBarCell1Rev">Package</li> <li>Class</li> <li><a href="package-use.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>Prev Package</li> <li><a href="../../../../com/fasterxml/jackson/databind/annotation/package-summary.html">Next Package</a></li> </ul> <ul class="navList"> <li><a href="../../../../index.html?com/fasterxml/jackson/databind/package-summary.html" target="_top">Frames</a></li> <li><a href="package-summary.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> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>