• 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_162) on Sat Apr 25 17:14:53 PDT 2020 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>com.fasterxml.jackson.databind.ser (jackson-databind 2.11.0 API)</title>
8<meta name="date" content="2020-04-25">
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.ser (jackson-databind 2.11.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><a href="../../../../../com/fasterxml/jackson/databind/node/package-summary.html">Prev&nbsp;Package</a></li>
48<li><a href="../../../../../com/fasterxml/jackson/databind/ser/impl/package-summary.html">Next&nbsp;Package</a></li>
49</ul>
50<ul class="navList">
51<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/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.ser</h1>
75<div class="docSummary">
76<div class="block">Contains implementation classes of serialization part of
77 data binding.</div>
78</div>
79<p>See:&nbsp;<a href="#package.description">Description</a></p>
80</div>
81<div class="contentContainer">
82<ul class="blockList">
83<li class="blockList">
84<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
85<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
86<tr>
87<th class="colFirst" scope="col">Interface</th>
88<th class="colLast" scope="col">Description</th>
89</tr>
90<tbody>
91<tr class="altColor">
92<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser">BeanPropertyFilter</a></td>
93<td class="colLast">Deprecated
94<div class="block"><span class="deprecationComment">Since 2.3: use <a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><code>PropertyFilter</code></a> instead.</span></div>
95</td>
96</tr>
97<tr class="rowColor">
98<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/ContextualSerializer.html" title="interface in com.fasterxml.jackson.databind.ser">ContextualSerializer</a></td>
99<td class="colLast">
100<div class="block">Add-on interface that <a href="../../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a>s can implement to get a callback
101 that can be used to create contextual instances of serializer to use for
102 handling properties of supported type.</div>
103</td>
104</tr>
105<tr class="altColor">
106<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser">PropertyFilter</a></td>
107<td class="colLast">
108<div class="block">Interface that defines API for filter objects use (as configured
109 using <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/com/fasterxml/jackson/annotation/JsonFilter.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonFilter</code></a>)
110 for filtering bean properties to serialize.</div>
111</td>
112</tr>
113<tr class="rowColor">
114<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/ResolvableSerializer.html" title="interface in com.fasterxml.jackson.databind.ser">ResolvableSerializer</a></td>
115<td class="colLast">
116<div class="block">Interface used to indicate serializers that want to do post-processing
117 after construction and being added to <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a>,
118 but before being used.</div>
119</td>
120</tr>
121<tr class="altColor">
122<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/Serializers.html" title="interface in com.fasterxml.jackson.databind.ser">Serializers</a></td>
123<td class="colLast">
124<div class="block">Interface that defines API for simple extensions that can provide additional serializers
125 for various types.</div>
126</td>
127</tr>
128</tbody>
129</table>
130</li>
131<li class="blockList">
132<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
133<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
134<tr>
135<th class="colFirst" scope="col">Class</th>
136<th class="colLast" scope="col">Description</th>
137</tr>
138<tbody>
139<tr class="altColor">
140<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/AnyGetterWriter.html" title="class in com.fasterxml.jackson.databind.ser">AnyGetterWriter</a></td>
141<td class="colLast">
142<div class="block">Class similar to <a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanPropertyWriter</code></a>, but that will be used
143 for serializing <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/com/fasterxml/jackson/annotation/JsonAnyGetter.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonAnyGetter</code></a> annotated
144 (Map) properties</div>
145</td>
146</tr>
147<tr class="rowColor">
148<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BasicSerializerFactory.html" title="class in com.fasterxml.jackson.databind.ser">BasicSerializerFactory</a></td>
149<td class="colLast">
150<div class="block">Factory class that can provide serializers for standard JDK classes,
151 as well as custom classes that extend standard classes or implement
152 one of "well-known" interfaces (such as <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>).</div>
153</td>
154</tr>
155<tr class="altColor">
156<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">BeanPropertyWriter</a></td>
157<td class="colLast">
158<div class="block">Base bean property handler class, which implements common parts of
159 reflection-based functionality for accessing a property value and serializing
160 it.</div>
161</td>
162</tr>
163<tr class="rowColor">
164<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializer.html" title="class in com.fasterxml.jackson.databind.ser">BeanSerializer</a></td>
165<td class="colLast">
166<div class="block">Serializer class that can serialize Java objects that map
167 to JSON Object output.</div>
168</td>
169</tr>
170<tr class="altColor">
171<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializerBuilder.html" title="class in com.fasterxml.jackson.databind.ser">BeanSerializerBuilder</a></td>
172<td class="colLast">
173<div class="block">Builder class used for aggregating deserialization information about
174 a POJO, in order to build a <a href="../../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a> for serializing
175 intances.</div>
176</td>
177</tr>
178<tr class="rowColor">
179<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializerFactory.html" title="class in com.fasterxml.jackson.databind.ser">BeanSerializerFactory</a></td>
180<td class="colLast">
181<div class="block">Factory class that can provide serializers for any regular Java beans
182 (as defined by "having at least one get method recognizable as bean
183 accessor" -- where <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang"><code>Object.getClass()</code></a> does not count);
184 as well as for "standard" JDK types.</div>
185</td>
186</tr>
187<tr class="altColor">
188<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializerModifier.html" title="class in com.fasterxml.jackson.databind.ser">BeanSerializerModifier</a></td>
189<td class="colLast">
190<div class="block">Abstract class that defines API for objects that can be registered (for <a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializerFactory.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanSerializerFactory</code></a>
191 to participate in constructing <a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializer.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanSerializer</code></a> instances.</div>
192</td>
193</tr>
194<tr class="rowColor">
195<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/ContainerSerializer.html" title="class in com.fasterxml.jackson.databind.ser">ContainerSerializer</a>&lt;T&gt;</td>
196<td class="colLast">
197<div class="block">Intermediate base class for serializers used for serializing
198 types that contain element(s) of other types, such as arrays,
199 <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>s (<code>Lists</code>, <code>Sets</code>
200 etc) and <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>s and iterable things
201 (<a href="https://docs.oracle.com/javase/8/docs/api/java/util/Iterator.html?is-external=true" title="class or interface in java.util"><code>Iterator</code></a>s).</div>
202</td>
203</tr>
204<tr class="altColor">
205<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/DefaultSerializerProvider.html" title="class in com.fasterxml.jackson.databind.ser">DefaultSerializerProvider</a></td>
206<td class="colLast">
207<div class="block">Standard implementation used by <a href="../../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>:
208 adds methods only exposed to <a href="../../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a>,
209 as well as constructors.</div>
210</td>
211</tr>
212<tr class="rowColor">
213<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/DefaultSerializerProvider.Impl.html" title="class in com.fasterxml.jackson.databind.ser">DefaultSerializerProvider.Impl</a></td>
214<td class="colLast">
215<div class="block">Concrete implementation that defines factory method(s),
216 defined as final.</div>
217</td>
218</tr>
219<tr class="altColor">
220<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/FilterProvider.html" title="class in com.fasterxml.jackson.databind.ser">FilterProvider</a></td>
221<td class="colLast">
222<div class="block">Interface for objects that providers instances of <a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyFilter.html" title="interface in com.fasterxml.jackson.databind.ser"><code>PropertyFilter</code></a>
223 that match given ids.</div>
224</td>
225</tr>
226<tr class="rowColor">
227<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyBuilder.html" title="class in com.fasterxml.jackson.databind.ser">PropertyBuilder</a></td>
228<td class="colLast">
229<div class="block">Helper class for <a href="../../../../../com/fasterxml/jackson/databind/ser/BeanSerializerFactory.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanSerializerFactory</code></a> that is used to
230 construct <a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanPropertyWriter</code></a> instances.</div>
231</td>
232</tr>
233<tr class="altColor">
234<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/PropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">PropertyWriter</a></td>
235<td class="colLast">
236<div class="block">Base class for writers used to output property values (name-value pairs)
237 as key/value pairs via streaming API.</div>
238</td>
239</tr>
240<tr class="rowColor">
241<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/SerializerCache.html" title="class in com.fasterxml.jackson.databind.ser">SerializerCache</a></td>
242<td class="colLast">
243<div class="block">Simple cache object that allows for doing 2-level lookups: first level is
244 by "local" read-only lookup Map (used without locking)
245 and second backup level is by a shared modifiable HashMap.</div>
246</td>
247</tr>
248<tr class="altColor">
249<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/SerializerFactory.html" title="class in com.fasterxml.jackson.databind.ser">SerializerFactory</a></td>
250<td class="colLast">
251<div class="block">Abstract class that defines API used by <a href="../../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><code>SerializerProvider</code></a>
252 to obtain actual
253 <a href="../../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a> instances from multiple distinct factories.</div>
254</td>
255</tr>
256<tr class="rowColor">
257<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/Serializers.Base.html" title="class in com.fasterxml.jackson.databind.ser">Serializers.Base</a></td>
258<td class="colLast">
259<div class="block">Basic <a href="../../../../../com/fasterxml/jackson/databind/ser/Serializers.html" title="interface in com.fasterxml.jackson.databind.ser"><code>Serializers</code></a> implementation that implements all methods but provides
260 no serializers.</div>
261</td>
262</tr>
263<tr class="altColor">
264<td class="colFirst"><a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a></td>
265<td class="colLast">
266<div class="block"><a href="../../../../../com/fasterxml/jackson/databind/ser/BeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>BeanPropertyWriter</code></a> implementation used with
267 <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.html" title="annotation in com.fasterxml.jackson.databind.annotation"><code>JsonAppend</code></a>
268 to add "virtual" properties in addition to regular ones.</div>
269</td>
270</tr>
271</tbody>
272</table>
273</li>
274</ul>
275<a name="package.description">
276<!--   -->
277</a>
278<h2 title="Package com.fasterxml.jackson.databind.ser Description">Package com.fasterxml.jackson.databind.ser Description</h2>
279<div class="block">Contains implementation classes of serialization part of
280 data binding.</div>
281</div>
282<!-- ======= START OF BOTTOM NAVBAR ====== -->
283<div class="bottomNav"><a name="navbar.bottom">
284<!--   -->
285</a>
286<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
287<a name="navbar.bottom.firstrow">
288<!--   -->
289</a>
290<ul class="navList" title="Navigation">
291<li><a href="../../../../../overview-summary.html">Overview</a></li>
292<li class="navBarCell1Rev">Package</li>
293<li>Class</li>
294<li><a href="package-use.html">Use</a></li>
295<li><a href="package-tree.html">Tree</a></li>
296<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
297<li><a href="../../../../../index-all.html">Index</a></li>
298<li><a href="../../../../../help-doc.html">Help</a></li>
299</ul>
300</div>
301<div class="subNav">
302<ul class="navList">
303<li><a href="../../../../../com/fasterxml/jackson/databind/node/package-summary.html">Prev&nbsp;Package</a></li>
304<li><a href="../../../../../com/fasterxml/jackson/databind/ser/impl/package-summary.html">Next&nbsp;Package</a></li>
305</ul>
306<ul class="navList">
307<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/ser/package-summary.html" target="_top">Frames</a></li>
308<li><a href="package-summary.html" target="_top">No&nbsp;Frames</a></li>
309</ul>
310<ul class="navList" id="allclasses_navbar_bottom">
311<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
312</ul>
313<div>
314<script type="text/javascript"><!--
315  allClassesLink = document.getElementById("allclasses_navbar_bottom");
316  if(window==top) {
317    allClassesLink.style.display = "block";
318  }
319  else {
320    allClassesLink.style.display = "none";
321  }
322  //-->
323</script>
324</div>
325<a name="skip.navbar.bottom">
326<!--   -->
327</a></div>
328<!-- ======== END OF BOTTOM NAVBAR ======= -->
329<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
330</body>
331</html>
332