• 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 Tue Jan 23 20:22:12 PST 2018 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>JsonSerializable.Base (jackson-databind 2.9.0 API)</title>
8<meta name="date" content="2018-01-23">
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="JsonSerializable.Base (jackson-databind 2.9.0 API)";
17        }
18    }
19    catch(err) {
20    }
21//-->
22var methods = {"i0":10};
23var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
33<div class="topNav"><a name="navbar.top">
34<!--   -->
35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
38<!--   -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/JsonSerializable.Base.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../index-all.html">Index</a></li>
48<li><a href="../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
53<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonSerializable.Base.html" target="_top">Frames</a></li>
58<li><a href="JsonSerializable.Base.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
62</ul>
63<div>
64<script type="text/javascript"><!--
65  allClassesLink = document.getElementById("allclasses_navbar_top");
66  if(window==top) {
67    allClassesLink.style.display = "block";
68  }
69  else {
70    allClassesLink.style.display = "none";
71  }
72  //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li>Nested&nbsp;|&nbsp;</li>
79<li>Field&nbsp;|&nbsp;</li>
80<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li>Field&nbsp;|&nbsp;</li>
86<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
88</ul>
89</div>
90<a name="skip.navbar.top">
91<!--   -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.fasterxml.jackson.databind</div>
97<h2 title="Class JsonSerializable.Base" class="title">Class JsonSerializable.Base</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
101<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
102<li>
103<ul class="inheritance">
104<li>com.fasterxml.jackson.databind.JsonSerializable.Base</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<dl>
112<dt>All Implemented Interfaces:</dt>
113<dd><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></dd>
114</dl>
115<dl>
116<dt>Direct Known Subclasses:</dt>
117<dd><a href="../../../../com/fasterxml/jackson/databind/JsonNode.html" title="class in com.fasterxml.jackson.databind">JsonNode</a></dd>
118</dl>
119<dl>
120<dt>Enclosing interface:</dt>
121<dd><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></dd>
122</dl>
123<hr>
124<br>
125<pre>public abstract static class <span class="typeNameLabel">JsonSerializable.Base</span>
126extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
127implements <a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></pre>
128<div class="block">Base class with minimal implementation, as well as couple of extension methods
129 that core Jackson databinding makes use of.
130 Use of this base class is strongly recommended over directly implementing
131 <a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind"><code>JsonSerializable</code></a>.</div>
132<dl>
133<dt><span class="simpleTagLabel">Since:</span></dt>
134<dd>2.6</dd>
135</dl>
136</li>
137</ul>
138</div>
139<div class="summary">
140<ul class="blockList">
141<li class="blockList">
142<!-- ======== NESTED CLASS SUMMARY ======== -->
143<ul class="blockList">
144<li class="blockList"><a name="nested.class.summary">
145<!--   -->
146</a>
147<h3>Nested Class Summary</h3>
148<ul class="blockList">
149<li class="blockList"><a name="nested.classes.inherited.from.class.com.fasterxml.jackson.databind.JsonSerializable">
150<!--   -->
151</a>
152<h3>Nested classes/interfaces inherited from interface&nbsp;com.fasterxml.jackson.databind.<a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></h3>
153<code><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.Base.html" title="class in com.fasterxml.jackson.databind">JsonSerializable.Base</a></code></li>
154</ul>
155</li>
156</ul>
157<!-- ======== CONSTRUCTOR SUMMARY ======== -->
158<ul class="blockList">
159<li class="blockList"><a name="constructor.summary">
160<!--   -->
161</a>
162<h3>Constructor Summary</h3>
163<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
164<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
165<tr>
166<th class="colOne" scope="col">Constructor and Description</th>
167</tr>
168<tr class="altColor">
169<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.Base.html#Base--">Base</a></span>()</code>&nbsp;</td>
170</tr>
171</table>
172</li>
173</ul>
174<!-- ========== METHOD SUMMARY =========== -->
175<ul class="blockList">
176<li class="blockList"><a name="method.summary">
177<!--   -->
178</a>
179<h3>Method Summary</h3>
180<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
181<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
182<tr>
183<th class="colFirst" scope="col">Modifier and Type</th>
184<th class="colLast" scope="col">Method and Description</th>
185</tr>
186<tr id="i0" class="altColor">
187<td class="colFirst"><code>boolean</code></td>
188<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.Base.html#isEmpty-com.fasterxml.jackson.databind.SerializerProvider-">isEmpty</a></span>(<a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a>&nbsp;serializers)</code>
189<div class="block">Method that may be called on instance to determine if it is considered
190 "empty" for purposes of serialization filtering or not.</div>
191</td>
192</tr>
193</table>
194<ul class="blockList">
195<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
196<!--   -->
197</a>
198<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
199<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
200</ul>
201<ul class="blockList">
202<li class="blockList"><a name="methods.inherited.from.class.com.fasterxml.jackson.databind.JsonSerializable">
203<!--   -->
204</a>
205<h3>Methods inherited from interface&nbsp;com.fasterxml.jackson.databind.<a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind">JsonSerializable</a></h3>
206<code><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html#serialize-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-">serialize</a>, <a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html#serializeWithType-com.fasterxml.jackson.core.JsonGenerator-com.fasterxml.jackson.databind.SerializerProvider-com.fasterxml.jackson.databind.jsontype.TypeSerializer-">serializeWithType</a></code></li>
207</ul>
208</li>
209</ul>
210</li>
211</ul>
212</div>
213<div class="details">
214<ul class="blockList">
215<li class="blockList">
216<!-- ========= CONSTRUCTOR DETAIL ======== -->
217<ul class="blockList">
218<li class="blockList"><a name="constructor.detail">
219<!--   -->
220</a>
221<h3>Constructor Detail</h3>
222<a name="Base--">
223<!--   -->
224</a>
225<ul class="blockListLast">
226<li class="blockList">
227<h4>Base</h4>
228<pre>public&nbsp;Base()</pre>
229</li>
230</ul>
231</li>
232</ul>
233<!-- ============ METHOD DETAIL ========== -->
234<ul class="blockList">
235<li class="blockList"><a name="method.detail">
236<!--   -->
237</a>
238<h3>Method Detail</h3>
239<a name="isEmpty-com.fasterxml.jackson.databind.SerializerProvider-">
240<!--   -->
241</a>
242<ul class="blockListLast">
243<li class="blockList">
244<h4>isEmpty</h4>
245<pre>public&nbsp;boolean&nbsp;isEmpty(<a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind">SerializerProvider</a>&nbsp;serializers)</pre>
246<div class="block">Method that may be called on instance to determine if it is considered
247 "empty" for purposes of serialization filtering or not.</div>
248</li>
249</ul>
250</li>
251</ul>
252</li>
253</ul>
254</div>
255</div>
256<!-- ========= END OF CLASS DATA ========= -->
257<!-- ======= START OF BOTTOM NAVBAR ====== -->
258<div class="bottomNav"><a name="navbar.bottom">
259<!--   -->
260</a>
261<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
262<a name="navbar.bottom.firstrow">
263<!--   -->
264</a>
265<ul class="navList" title="Navigation">
266<li><a href="../../../../overview-summary.html">Overview</a></li>
267<li><a href="package-summary.html">Package</a></li>
268<li class="navBarCell1Rev">Class</li>
269<li><a href="class-use/JsonSerializable.Base.html">Use</a></li>
270<li><a href="package-tree.html">Tree</a></li>
271<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
272<li><a href="../../../../index-all.html">Index</a></li>
273<li><a href="../../../../help-doc.html">Help</a></li>
274</ul>
275</div>
276<div class="subNav">
277<ul class="navList">
278<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializable.html" title="interface in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
279<li><a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
280</ul>
281<ul class="navList">
282<li><a href="../../../../index.html?com/fasterxml/jackson/databind/JsonSerializable.Base.html" target="_top">Frames</a></li>
283<li><a href="JsonSerializable.Base.html" target="_top">No&nbsp;Frames</a></li>
284</ul>
285<ul class="navList" id="allclasses_navbar_bottom">
286<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
287</ul>
288<div>
289<script type="text/javascript"><!--
290  allClassesLink = document.getElementById("allclasses_navbar_bottom");
291  if(window==top) {
292    allClassesLink.style.display = "block";
293  }
294  else {
295    allClassesLink.style.display = "none";
296  }
297  //-->
298</script>
299</div>
300<div>
301<ul class="subNavList">
302<li>Summary:&nbsp;</li>
303<li>Nested&nbsp;|&nbsp;</li>
304<li>Field&nbsp;|&nbsp;</li>
305<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
306<li><a href="#method.summary">Method</a></li>
307</ul>
308<ul class="subNavList">
309<li>Detail:&nbsp;</li>
310<li>Field&nbsp;|&nbsp;</li>
311<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
312<li><a href="#method.detail">Method</a></li>
313</ul>
314</div>
315<a name="skip.navbar.bottom">
316<!--   -->
317</a></div>
318<!-- ======== END OF BOTTOM NAVBAR ======= -->
319<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
320</body>
321</html>
322