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>SerializationFeature (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="SerializationFeature (jackson-databind 2.9.0 API)"; 17 } 18 } 19 catch(err) { 20 } 21//--> 22var methods = {"i0":10,"i1":10,"i2":10,"i3":9,"i4":9}; 23var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/SerializationFeature.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/SerializationConfig.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 54<li><a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 55</ul> 56<ul class="navList"> 57<li><a href="../../../../index.html?com/fasterxml/jackson/databind/SerializationFeature.html" target="_top">Frames</a></li> 58<li><a href="SerializationFeature.html" target="_top">No Frames</a></li> 59</ul> 60<ul class="navList" id="allclasses_navbar_top"> 61<li><a href="../../../../allclasses-noframe.html">All 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: </li> 78<li>Nested | </li> 79<li><a href="#enum.constant.summary">Enum Constants</a> | </li> 80<li>Field | </li> 81<li><a href="#method.summary">Method</a></li> 82</ul> 83<ul class="subNavList"> 84<li>Detail: </li> 85<li><a href="#enum.constant.detail">Enum Constants</a> | </li> 86<li>Field | </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="Enum SerializationFeature" class="title">Enum SerializationFeature</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><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a>></li> 105<li> 106<ul class="inheritance"> 107<li>com.fasterxml.jackson.databind.SerializationFeature</li> 108</ul> 109</li> 110</ul> 111</li> 112</ul> 113<div class="description"> 114<ul class="blockList"> 115<li class="blockList"> 116<dl> 117<dt>All Implemented Interfaces:</dt> 118<dd><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a>></dd> 119</dl> 120<hr> 121<br> 122<pre>public enum <span class="typeNameLabel">SerializationFeature</span> 123extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a>> 124implements <a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</a></pre> 125<div class="block">Enumeration that defines simple on/off features that affect 126 the way Java objects are serialized. 127<p> 128 Note that features can be set both through 129 <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (as sort of defaults) and through 130 <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>. 131 In first case these defaults must follow "config-then-use" patterns 132 (i.e. defined once, not changed afterwards); all per-call 133 changes must be done using <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>.</div> 134</li> 135</ul> 136</div> 137<div class="summary"> 138<ul class="blockList"> 139<li class="blockList"> 140<!-- =========== ENUM CONSTANT SUMMARY =========== --> 141<ul class="blockList"> 142<li class="blockList"><a name="enum.constant.summary"> 143<!-- --> 144</a> 145<h3>Enum Constant Summary</h3> 146<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 147<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 148<tr> 149<th class="colOne" scope="col">Enum Constant and Description</th> 150</tr> 151<tr class="altColor"> 152<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#CLOSE_CLOSEABLE">CLOSE_CLOSEABLE</a></span></code> 153<div class="block">Feature that determines whether <code>close</code> method of 154 serialized <b>root level</b> objects (ones for which <code>ObjectMapper</code>'s 155 writeValue() (or equivalent) method is called) 156 that implement <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io"><code>Closeable</code></a> 157 is called after serialization or not.</div> 158</td> 159</tr> 160<tr class="rowColor"> 161<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#EAGER_SERIALIZER_FETCH">EAGER_SERIALIZER_FETCH</a></span></code> 162<div class="block">Feature that determines whether <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> should 163 try to eagerly fetch necessary <a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a> when 164 possible.</div> 165</td> 166</tr> 167<tr class="altColor"> 168<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#FAIL_ON_EMPTY_BEANS">FAIL_ON_EMPTY_BEANS</a></span></code> 169<div class="block">Feature that determines what happens when no accessors are 170 found for a type (and there are no annotations to indicate 171 it is meant to be serialized).</div> 172</td> 173</tr> 174<tr class="rowColor"> 175<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#FAIL_ON_SELF_REFERENCES">FAIL_ON_SELF_REFERENCES</a></span></code> 176<div class="block">Feature that determines what happens when a direct self-reference 177 is detected by a POJO (and no Object Id handling is enabled for it): 178 either a <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind"><code>JsonMappingException</code></a> is 179 thrown (if true), or reference is normally processed (false).</div> 180</td> 181</tr> 182<tr class="altColor"> 183<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS">FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS</a></span></code> 184<div class="block">Feature that determines what happens when an object which 185 normally has type information included by Jackson is used 186 in conjunction with <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonUnwrapped.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonUnwrapped</code></a>.</div> 187</td> 188</tr> 189<tr class="rowColor"> 190<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#FLUSH_AFTER_WRITE_VALUE">FLUSH_AFTER_WRITE_VALUE</a></span></code> 191<div class="block">Feature that determines whether <code>JsonGenerator.flush()</code> is 192 called after <code>writeValue()</code> method <b>that takes JsonGenerator 193 as an argument</b> completes (i.e.</div> 194</td> 195</tr> 196<tr class="altColor"> 197<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#INDENT_OUTPUT">INDENT_OUTPUT</a></span></code> 198<div class="block">Feature that allows enabling (or disabling) indentation 199 for the underlying generator, using the default pretty 200 printer configured for <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (and 201 <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>s created from mapper).</div> 202</td> 203</tr> 204<tr class="rowColor"> 205<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#ORDER_MAP_ENTRIES_BY_KEYS">ORDER_MAP_ENTRIES_BY_KEYS</a></span></code> 206<div class="block">Feature that determines whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> entries are first 207 sorted by key before serialization or not: if enabled, additional sorting 208 step is performed if necessary (not necessary for <a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a>s), 209 if disabled, no additional sorting is needed.</div> 210</td> 211</tr> 212<tr class="altColor"> 213<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#USE_EQUALITY_FOR_OBJECT_ID">USE_EQUALITY_FOR_OBJECT_ID</a></span></code> 214<div class="block">Feature that determines whether Object Identity is compared using 215 true JVM-level identity of Object (false); or, <code>equals()</code> method.</div> 216</td> 217</tr> 218<tr class="rowColor"> 219<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRAP_EXCEPTIONS">WRAP_EXCEPTIONS</a></span></code> 220<div class="block">Feature that determines whether Jackson code should catch 221 and wrap <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><code>Exception</code></a>s (but never <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Error.html?is-external=true" title="class or interface in java.lang"><code>Error</code></a>s!) 222 to add additional information about 223 location (within input) of problem or not.</div> 224</td> 225</tr> 226<tr class="altColor"> 227<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRAP_ROOT_VALUE">WRAP_ROOT_VALUE</a></span></code> 228<div class="block">Feature that can be enabled to make root value (usually JSON 229 Object but can be any type) wrapped within a single property 230 JSON object, where key as the "root name", as determined by 231 annotation introspector (esp.</div> 232</td> 233</tr> 234<tr class="rowColor"> 235<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_BIGDECIMAL_AS_PLAIN">WRITE_BIGDECIMAL_AS_PLAIN</a></span></code> 236<div class="block"><span class="deprecatedLabel">Deprecated.</span> 237<div class="block"><span class="deprecationComment">Since 2.5: use <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.Feature.html?is-external=true#WRITE_BIGDECIMAL_AS_PLAIN" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN</code></a> instead 238 (using <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html#with-com.fasterxml.jackson.core.JsonGenerator.Feature-"><code>ObjectWriter.with(com.fasterxml.jackson.core.JsonGenerator.Feature)</code></a>).</span></div> 239</div> 240</td> 241</tr> 242<tr class="altColor"> 243<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS">WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS</a></span></code> 244<div class="block">Feature that determines how type <code>char[]</code> is serialized: 245 when enabled, will be serialized as an explict JSON array (with 246 single-character Strings as values); when disabled, defaults to 247 serializing them as Strings (which is more compact).</div> 248</td> 249</tr> 250<tr class="rowColor"> 251<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATE_KEYS_AS_TIMESTAMPS">WRITE_DATE_KEYS_AS_TIMESTAMPS</a></span></code> 252<div class="block">Feature that determines whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>s 253 (and sub-types) used as <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> keys are serialized 254 as timestamps or not (if not, will be serialized as textual 255 values).</div> 256</td> 257</tr> 258<tr class="altColor"> 259<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS">WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS</a></span></code> 260<div class="block">Feature that controls whether numeric timestamp values are 261 to be written using nanosecond timestamps (enabled) or not (disabled); 262 <b>if and only if</b> datatype supports such resolution.</div> 263</td> 264</tr> 265<tr class="rowColor"> 266<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATES_AS_TIMESTAMPS">WRITE_DATES_AS_TIMESTAMPS</a></span></code> 267<div class="block">Feature that determines whether Date (and date/time) values 268 (and Date-based things like <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a>s) are to be 269 serialized as numeric timestamps (true; the default), 270 or as something else (usually textual representation).</div> 271</td> 272</tr> 273<tr class="altColor"> 274<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATES_WITH_ZONE_ID">WRITE_DATES_WITH_ZONE_ID</a></span></code> 275<div class="block">Feature that determines whether date/date-time values should be serialized 276 so that they include timezone id, in cases where type itself contains 277 timezone information.</div> 278</td> 279</tr> 280<tr class="rowColor"> 281<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DURATIONS_AS_TIMESTAMPS">WRITE_DURATIONS_AS_TIMESTAMPS</a></span></code> 282<div class="block">Feature that determines whether time values that represents time periods 283 (durations, periods, ranges) are to be serialized by default using 284 a numeric (true) or textual (false) representations.</div> 285</td> 286</tr> 287<tr class="altColor"> 288<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_EMPTY_JSON_ARRAYS">WRITE_EMPTY_JSON_ARRAYS</a></span></code> 289<div class="block"><span class="deprecatedLabel">Deprecated.</span> 290<div class="block"><span class="deprecationComment">Since 2.8 there are better mechanism for specifying filtering; specifically 291 using <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> or configuration overrides.</span></div> 292</div> 293</td> 294</tr> 295<tr class="rowColor"> 296<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_ENUMS_USING_INDEX">WRITE_ENUMS_USING_INDEX</a></span></code> 297<div class="block">Feature that determines whethere Java Enum values are serialized 298 as numbers (true), or textual values (false).</div> 299</td> 300</tr> 301<tr class="altColor"> 302<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_ENUMS_USING_TO_STRING">WRITE_ENUMS_USING_TO_STRING</a></span></code> 303<div class="block">Feature that determines standard serialization mechanism used for 304 Enum values: if enabled, return value of <code>Enum.toString()</code> 305 is used; if disabled, return value of <code>Enum.name()</code> is used.</div> 306</td> 307</tr> 308<tr class="rowColor"> 309<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_NULL_MAP_VALUES">WRITE_NULL_MAP_VALUES</a></span></code> 310<div class="block"><span class="deprecatedLabel">Deprecated.</span> 311<div class="block"><span class="deprecationComment">Since 2.9 there are better mechanism for specifying filtering; specifically 312 using <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> or configuration overrides 313 (see <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#configOverride-java.lang.Class-"><code>ObjectMapper.configOverride(Class)</code></a>}).</span></div> 314</div> 315</td> 316</tr> 317<tr class="altColor"> 318<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED">WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED</a></span></code> 319<div class="block">Feature added for interoperability, to work with oddities of 320 so-called "BadgerFish" convention.</div> 321</td> 322</tr> 323</table> 324</li> 325</ul> 326<!-- ========== METHOD SUMMARY =========== --> 327<ul class="blockList"> 328<li class="blockList"><a name="method.summary"> 329<!-- --> 330</a> 331<h3>Method Summary</h3> 332<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 333<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> 334<tr> 335<th class="colFirst" scope="col">Modifier and Type</th> 336<th class="colLast" scope="col">Method and Description</th> 337</tr> 338<tr id="i0" class="altColor"> 339<td class="colFirst"><code>boolean</code></td> 340<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#enabledByDefault--">enabledByDefault</a></span>()</code> 341<div class="block">Accessor for checking whether this feature is enabled by default.</div> 342</td> 343</tr> 344<tr id="i1" class="rowColor"> 345<td class="colFirst"><code>boolean</code></td> 346<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#enabledIn-int-">enabledIn</a></span>(int flags)</code> 347<div class="block">Convenience method for checking whether feature is enabled in given bitmask</div> 348</td> 349</tr> 350<tr id="i2" class="altColor"> 351<td class="colFirst"><code>int</code></td> 352<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#getMask--">getMask</a></span>()</code> 353<div class="block">Returns bit mask for this feature instance</div> 354</td> 355</tr> 356<tr id="i3" class="rowColor"> 357<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a></code></td> 358<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> 359<div class="block">Returns the enum constant of this type with the specified name.</div> 360</td> 361</tr> 362<tr id="i4" class="altColor"> 363<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a>[]</code></td> 364<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#values--">values</a></span>()</code> 365<div class="block">Returns an array containing the constants of this enum type, in 366the order they are declared.</div> 367</td> 368</tr> 369</table> 370<ul class="blockList"> 371<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum"> 372<!-- --> 373</a> 374<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> 375<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li> 376</ul> 377<ul class="blockList"> 378<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> 379<!-- --> 380</a> 381<h3>Methods inherited from class 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> 382<code><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#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#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> 383</ul> 384</li> 385</ul> 386</li> 387</ul> 388</div> 389<div class="details"> 390<ul class="blockList"> 391<li class="blockList"> 392<!-- ============ ENUM CONSTANT DETAIL =========== --> 393<ul class="blockList"> 394<li class="blockList"><a name="enum.constant.detail"> 395<!-- --> 396</a> 397<h3>Enum Constant Detail</h3> 398<a name="WRAP_ROOT_VALUE"> 399<!-- --> 400</a> 401<ul class="blockList"> 402<li class="blockList"> 403<h4>WRAP_ROOT_VALUE</h4> 404<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRAP_ROOT_VALUE</pre> 405<div class="block">Feature that can be enabled to make root value (usually JSON 406 Object but can be any type) wrapped within a single property 407 JSON object, where key as the "root name", as determined by 408 annotation introspector (esp. for JAXB that uses 409 <code>@XmlRootElement.name</code>) or fallback (non-qualified 410 class name). 411 Feature is mostly intended for JAXB compatibility. 412<p> 413 Feature is disabled by default.</div> 414</li> 415</ul> 416<a name="INDENT_OUTPUT"> 417<!-- --> 418</a> 419<ul class="blockList"> 420<li class="blockList"> 421<h4>INDENT_OUTPUT</h4> 422<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> INDENT_OUTPUT</pre> 423<div class="block">Feature that allows enabling (or disabling) indentation 424 for the underlying generator, using the default pretty 425 printer configured for <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html" title="class in com.fasterxml.jackson.databind"><code>ObjectMapper</code></a> (and 426 <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>s created from mapper). 427<p> 428 Note that the default pretty printer is only used if 429 no explicit <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/PrettyPrinter.html?is-external=true" title="class or interface in com.fasterxml.jackson.core"><code>PrettyPrinter</code></a> has been configured 430 for the generator or <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>. 431<p> 432 Feature is disabled by default.</div> 433</li> 434</ul> 435<a name="FAIL_ON_EMPTY_BEANS"> 436<!-- --> 437</a> 438<ul class="blockList"> 439<li class="blockList"> 440<h4>FAIL_ON_EMPTY_BEANS</h4> 441<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> FAIL_ON_EMPTY_BEANS</pre> 442<div class="block">Feature that determines what happens when no accessors are 443 found for a type (and there are no annotations to indicate 444 it is meant to be serialized). If enabled (default), an 445 exception is thrown to indicate these as non-serializable 446 types; if disabled, they are serialized as empty Objects, 447 i.e. without any properties. 448<p> 449 Note that empty types that this feature has only effect on 450 those "empty" beans that do not have any recognized annotations 451 (like <code>@JsonSerialize</code>): ones that do have annotations 452 do not result in an exception being thrown. 453<p> 454 Feature is enabled by default.</div> 455</li> 456</ul> 457<a name="FAIL_ON_SELF_REFERENCES"> 458<!-- --> 459</a> 460<ul class="blockList"> 461<li class="blockList"> 462<h4>FAIL_ON_SELF_REFERENCES</h4> 463<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> FAIL_ON_SELF_REFERENCES</pre> 464<div class="block">Feature that determines what happens when a direct self-reference 465 is detected by a POJO (and no Object Id handling is enabled for it): 466 either a <a href="../../../../com/fasterxml/jackson/databind/JsonMappingException.html" title="class in com.fasterxml.jackson.databind"><code>JsonMappingException</code></a> is 467 thrown (if true), or reference is normally processed (false). 468<p> 469 Feature is enabled by default.</div> 470<dl> 471<dt><span class="simpleTagLabel">Since:</span></dt> 472<dd>2.4</dd> 473</dl> 474</li> 475</ul> 476<a name="WRAP_EXCEPTIONS"> 477<!-- --> 478</a> 479<ul class="blockList"> 480<li class="blockList"> 481<h4>WRAP_EXCEPTIONS</h4> 482<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRAP_EXCEPTIONS</pre> 483<div class="block">Feature that determines whether Jackson code should catch 484 and wrap <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang"><code>Exception</code></a>s (but never <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Error.html?is-external=true" title="class or interface in java.lang"><code>Error</code></a>s!) 485 to add additional information about 486 location (within input) of problem or not. If enabled, 487 most exceptions will be caught and re-thrown (exception 488 specifically being that <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 may be passed 489 as is, since they are declared as throwable); this can be 490 convenient both in that all exceptions will be checked and 491 declared, and so there is more contextual information. 492 However, sometimes calling application may just want "raw" 493 unchecked exceptions passed as is. 494<p> 495<p> 496 Feature is enabled by default.</div> 497</li> 498</ul> 499<a name="FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS"> 500<!-- --> 501</a> 502<ul class="blockList"> 503<li class="blockList"> 504<h4>FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS</h4> 505<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> FAIL_ON_UNWRAPPED_TYPE_IDENTIFIERS</pre> 506<div class="block">Feature that determines what happens when an object which 507 normally has type information included by Jackson is used 508 in conjunction with <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonUnwrapped.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonUnwrapped</code></a>. 509 In the default (enabled) state, an error will be thrown when 510 an unwrapped object has type information. When disabled, the 511 object will be unwrapped and the type information discarded. 512<p> 513 Feature is enabled by default.</div> 514<dl> 515<dt><span class="simpleTagLabel">Since:</span></dt> 516<dd>2.4</dd> 517</dl> 518</li> 519</ul> 520<a name="CLOSE_CLOSEABLE"> 521<!-- --> 522</a> 523<ul class="blockList"> 524<li class="blockList"> 525<h4>CLOSE_CLOSEABLE</h4> 526<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> CLOSE_CLOSEABLE</pre> 527<div class="block">Feature that determines whether <code>close</code> method of 528 serialized <b>root level</b> objects (ones for which <code>ObjectMapper</code>'s 529 writeValue() (or equivalent) method is called) 530 that implement <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Closeable.html?is-external=true" title="class or interface in java.io"><code>Closeable</code></a> 531 is called after serialization or not. If enabled, <b>close()</b> will 532 be called after serialization completes (whether succesfully, or 533 due to an error manifested by an exception being thrown). You can 534 think of this as sort of "finally" processing. 535<p> 536 NOTE: only affects behavior with <b>root</b> objects, and not other 537 objects reachable from the root object. Put another way, only one 538 call will be made for each 'writeValue' call. 539<p> 540 Feature is disabled by default.</div> 541</li> 542</ul> 543<a name="FLUSH_AFTER_WRITE_VALUE"> 544<!-- --> 545</a> 546<ul class="blockList"> 547<li class="blockList"> 548<h4>FLUSH_AFTER_WRITE_VALUE</h4> 549<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> FLUSH_AFTER_WRITE_VALUE</pre> 550<div class="block">Feature that determines whether <code>JsonGenerator.flush()</code> is 551 called after <code>writeValue()</code> method <b>that takes JsonGenerator 552 as an argument</b> completes (i.e. does NOT affect methods 553 that use other destinations); same for methods in <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a>. 554 This usually makes sense; but there are cases where flushing 555 should not be forced: for example when underlying stream is 556 compressing and flush() causes compression state to be flushed 557 (which occurs with some compression codecs). 558<p> 559 Feature is enabled by default.</div> 560</li> 561</ul> 562<a name="WRITE_DATES_AS_TIMESTAMPS"> 563<!-- --> 564</a> 565<ul class="blockList"> 566<li class="blockList"> 567<h4>WRITE_DATES_AS_TIMESTAMPS</h4> 568<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_DATES_AS_TIMESTAMPS</pre> 569<div class="block">Feature that determines whether Date (and date/time) values 570 (and Date-based things like <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Calendar.html?is-external=true" title="class or interface in java.util"><code>Calendar</code></a>s) are to be 571 serialized as numeric timestamps (true; the default), 572 or as something else (usually textual representation). 573 If textual representation is used, the actual format is 574 one returned by a call to 575 <a href="../../../../com/fasterxml/jackson/databind/cfg/MapperConfig.html#getDateFormat--"><code>MapperConfig.getDateFormat()</code></a>: 576 the default setting being <a href="../../../../com/fasterxml/jackson/databind/util/StdDateFormat.html" title="class in com.fasterxml.jackson.databind.util"><code>StdDateFormat</code></a>, 577 which corresponds to format String of "yyyy-MM-dd'T'HH:mm:ss.SSSZ" 578 (see <a href="http://docs.oracle.com/javase/7/docs/api/java/text/DateFormat.html?is-external=true" title="class or interface in java.text"><code>DateFormat</code></a> for details of format Strings). 579<p> 580 Note: whether this feature affects handling of other date-related 581 types depend on handlers of those types, although ideally they 582 should use this feature 583<p> 584 Note: whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> keys are serialized as Strings 585 or not is controlled using <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATE_KEYS_AS_TIMESTAMPS"><code>WRITE_DATE_KEYS_AS_TIMESTAMPS</code></a>. 586<p> 587 Feature is enabled by default, so that date/time are by default 588 serialized as timestamps.</div> 589</li> 590</ul> 591<a name="WRITE_DATE_KEYS_AS_TIMESTAMPS"> 592<!-- --> 593</a> 594<ul class="blockList"> 595<li class="blockList"> 596<h4>WRITE_DATE_KEYS_AS_TIMESTAMPS</h4> 597<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_DATE_KEYS_AS_TIMESTAMPS</pre> 598<div class="block">Feature that determines whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>s 599 (and sub-types) used as <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> keys are serialized 600 as timestamps or not (if not, will be serialized as textual 601 values). 602<p> 603 Default value is 'false', meaning that Date-valued Map keys are serialized 604 as textual (ISO-8601) values. 605<p> 606 Feature is disabled by default.</div> 607</li> 608</ul> 609<a name="WRITE_DATES_WITH_ZONE_ID"> 610<!-- --> 611</a> 612<ul class="blockList"> 613<li class="blockList"> 614<h4>WRITE_DATES_WITH_ZONE_ID</h4> 615<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_DATES_WITH_ZONE_ID</pre> 616<div class="block">Feature that determines whether date/date-time values should be serialized 617 so that they include timezone id, in cases where type itself contains 618 timezone information. Including this information may lead to compatibility 619 issues because ISO-8601 specification does not define formats that include 620 such information. 621<p> 622 If enabled, Timezone id should be included using format specified 623 with Java 8 <code>DateTimeFormatter#ISO_ZONED_DATE_TIME</code> definition 624 (for example, '2011-12-03T10:15:30+01:00[Europe/Paris]'). 625<p> 626 Note: setting has no relevance if date/time values are serialized as timestamps. 627<p> 628 Feature is disabled by default, so that zone id is NOT included; rather, timezone 629 offset is used for ISO-8601 compatibility (if any timezone information is 630 included in value).</div> 631<dl> 632<dt><span class="simpleTagLabel">Since:</span></dt> 633<dd>2.6</dd> 634</dl> 635</li> 636</ul> 637<a name="WRITE_DURATIONS_AS_TIMESTAMPS"> 638<!-- --> 639</a> 640<ul class="blockList"> 641<li class="blockList"> 642<h4>WRITE_DURATIONS_AS_TIMESTAMPS</h4> 643<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_DURATIONS_AS_TIMESTAMPS</pre> 644<div class="block">Feature that determines whether time values that represents time periods 645 (durations, periods, ranges) are to be serialized by default using 646 a numeric (true) or textual (false) representations. Note that numeric 647 representation may mean either simple number, or an array of numbers, 648 depending on type. 649<p> 650 Note: whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> keys are serialized as Strings 651 or not is controlled using <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATE_KEYS_AS_TIMESTAMPS"><code>WRITE_DATE_KEYS_AS_TIMESTAMPS</code></a>. 652<p> 653 Feature is enabled by default, so that period/duration are by default 654 serialized as timestamps.</div> 655<dl> 656<dt><span class="simpleTagLabel">Since:</span></dt> 657<dd>2.5</dd> 658</dl> 659</li> 660</ul> 661<a name="WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS"> 662<!-- --> 663</a> 664<ul class="blockList"> 665<li class="blockList"> 666<h4>WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS</h4> 667<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_CHAR_ARRAYS_AS_JSON_ARRAYS</pre> 668<div class="block">Feature that determines how type <code>char[]</code> is serialized: 669 when enabled, will be serialized as an explict JSON array (with 670 single-character Strings as values); when disabled, defaults to 671 serializing them as Strings (which is more compact). 672<p> 673 Feature is disabled by default.</div> 674</li> 675</ul> 676<a name="WRITE_ENUMS_USING_TO_STRING"> 677<!-- --> 678</a> 679<ul class="blockList"> 680<li class="blockList"> 681<h4>WRITE_ENUMS_USING_TO_STRING</h4> 682<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_ENUMS_USING_TO_STRING</pre> 683<div class="block">Feature that determines standard serialization mechanism used for 684 Enum values: if enabled, return value of <code>Enum.toString()</code> 685 is used; if disabled, return value of <code>Enum.name()</code> is used. 686<p> 687 Note: this feature should usually have same value 688 as <a href="../../../../com/fasterxml/jackson/databind/DeserializationFeature.html#READ_ENUMS_USING_TO_STRING"><code>DeserializationFeature.READ_ENUMS_USING_TO_STRING</code></a>. 689<p> 690 Feature is disabled by default.</div> 691</li> 692</ul> 693<a name="WRITE_ENUMS_USING_INDEX"> 694<!-- --> 695</a> 696<ul class="blockList"> 697<li class="blockList"> 698<h4>WRITE_ENUMS_USING_INDEX</h4> 699<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_ENUMS_USING_INDEX</pre> 700<div class="block">Feature that determines whethere Java Enum values are serialized 701 as numbers (true), or textual values (false). If textual values are 702 used, other settings are also considered. 703 If this feature is enabled, 704 return value of <code>Enum.ordinal()</code> 705 (an integer) will be used as the serialization. 706<p> 707 Note that this feature has precedence over <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_ENUMS_USING_TO_STRING"><code>WRITE_ENUMS_USING_TO_STRING</code></a>, 708 which is only considered if this feature is set to false. 709<p> 710 Feature is disabled by default.</div> 711</li> 712</ul> 713<a name="WRITE_NULL_MAP_VALUES"> 714<!-- --> 715</a> 716<ul class="blockList"> 717<li class="blockList"> 718<h4>WRITE_NULL_MAP_VALUES</h4> 719<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 720public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_NULL_MAP_VALUES</pre> 721<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.9 there are better mechanism for specifying filtering; specifically 722 using <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> or configuration overrides 723 (see <a href="../../../../com/fasterxml/jackson/databind/ObjectMapper.html#configOverride-java.lang.Class-"><code>ObjectMapper.configOverride(Class)</code></a>}).</span></div> 724<div class="block">Feature that determines whether Map entries with null values are 725 to be serialized (true) or not (false). 726<p> 727 NOTE: unlike other <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind"><code>SerializationFeature</code></a>s, this feature <b>cannot</b> be 728 dynamically changed on per-call basis, because its effect is considered during 729 construction of serializers and property handlers. 730<p> 731 Feature is enabled by default.</div> 732</li> 733</ul> 734<a name="WRITE_EMPTY_JSON_ARRAYS"> 735<!-- --> 736</a> 737<ul class="blockList"> 738<li class="blockList"> 739<h4>WRITE_EMPTY_JSON_ARRAYS</h4> 740<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 741public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_EMPTY_JSON_ARRAYS</pre> 742<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.8 there are better mechanism for specifying filtering; specifically 743 using <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.9/com/fasterxml/jackson/annotation/JsonInclude.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> or configuration overrides.</span></div> 744<div class="block">Feature that determines whether Container properties (POJO properties 745 with declared value of Collection or array; i.e. things that produce JSON 746 arrays) that are empty (have no elements) 747 will be serialized as empty JSON arrays (true), or suppressed from output (false). 748<p> 749 Note that this does not change behavior of <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>s, or 750 "Collection-like" types. 751<p> 752 NOTE: unlike other <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind"><code>SerializationFeature</code></a>s, this feature <b>cannot</b> be 753 dynamically changed on per-call basis, because its effect is considered during 754 construction of serializers and property handlers. 755<p> 756 Feature is enabled by default.</div> 757</li> 758</ul> 759<a name="WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED"> 760<!-- --> 761</a> 762<ul class="blockList"> 763<li class="blockList"> 764<h4>WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED</h4> 765<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_SINGLE_ELEM_ARRAYS_UNWRAPPED</pre> 766<div class="block">Feature added for interoperability, to work with oddities of 767 so-called "BadgerFish" convention. 768 Feature determines handling of single element <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>s 769 and arrays: if enabled, <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>s and arrays that contain exactly 770 one element will be serialized as if that element itself was serialized. 771<p> 772 When enabled, a POJO with array that normally looks like this: 773<pre> 774 { "arrayProperty" : [ 1 ] } 775</pre> 776 will instead be serialized as 777<pre> 778 { "arrayProperty" : 1 } 779</pre> 780<p> 781 Note that this feature is counterpart to <a href="../../../../com/fasterxml/jackson/databind/DeserializationFeature.html#ACCEPT_SINGLE_VALUE_AS_ARRAY"><code>DeserializationFeature.ACCEPT_SINGLE_VALUE_AS_ARRAY</code></a> 782 (that is, usually both are enabled, or neither is). 783<p> 784 Feature is disabled by default, so that no special handling is done.</div> 785</li> 786</ul> 787<a name="WRITE_BIGDECIMAL_AS_PLAIN"> 788<!-- --> 789</a> 790<ul class="blockList"> 791<li class="blockList"> 792<h4>WRITE_BIGDECIMAL_AS_PLAIN</h4> 793<pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> 794public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_BIGDECIMAL_AS_PLAIN</pre> 795<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">Since 2.5: use <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.Feature.html?is-external=true#WRITE_BIGDECIMAL_AS_PLAIN" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator.Feature.WRITE_BIGDECIMAL_AS_PLAIN</code></a> instead 796 (using <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html#with-com.fasterxml.jackson.core.JsonGenerator.Feature-"><code>ObjectWriter.with(com.fasterxml.jackson.core.JsonGenerator.Feature)</code></a>).</span></div> 797<div class="block">Feature that determines whether <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true" title="class or interface in java.math"><code>BigDecimal</code></a> entries are 798 serialized using <a href="http://docs.oracle.com/javase/7/docs/api/java/math/BigDecimal.html?is-external=true#toPlainString--" title="class or interface in java.math"><code>BigDecimal.toPlainString()</code></a> to prevent 799 values to be written using scientific notation. 800<p> 801 NOTE: since this feature typically requires use of 802 <a href="http://fasterxml.github.com/jackson-core/javadoc/2.9/com/fasterxml/jackson/core/JsonGenerator.html?is-external=true#writeNumber-java.lang.String-" title="class or interface in com.fasterxml.jackson.core"><code>JsonGenerator.writeNumber(String)</code></a> 803 it may cause compatibility problems since not all <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> 804 implementations support such mode of output: usually only text-based formats 805 support it. 806<p> 807 Feature is disabled by default.</div> 808</li> 809</ul> 810<a name="WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS"> 811<!-- --> 812</a> 813<ul class="blockList"> 814<li class="blockList"> 815<h4>WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS</h4> 816<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS</pre> 817<div class="block">Feature that controls whether numeric timestamp values are 818 to be written using nanosecond timestamps (enabled) or not (disabled); 819 <b>if and only if</b> datatype supports such resolution. 820 Only newer datatypes (such as Java8 Date/Time) support such resolution -- 821 older types (pre-Java8 <b>java.util.Date</b> etc) and Joda do not -- 822 and this setting <b>has no effect</b> on such types. 823<p> 824 If disabled, standard millisecond timestamps are assumed. 825 This is the counterpart to <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html#WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS"><code>WRITE_DATE_TIMESTAMPS_AS_NANOSECONDS</code></a>. 826<p> 827 Feature is enabled by default, to support most accurate time values possible.</div> 828<dl> 829<dt><span class="simpleTagLabel">Since:</span></dt> 830<dd>2.2</dd> 831</dl> 832</li> 833</ul> 834<a name="ORDER_MAP_ENTRIES_BY_KEYS"> 835<!-- --> 836</a> 837<ul class="blockList"> 838<li class="blockList"> 839<h4>ORDER_MAP_ENTRIES_BY_KEYS</h4> 840<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> ORDER_MAP_ENTRIES_BY_KEYS</pre> 841<div class="block">Feature that determines whether <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> entries are first 842 sorted by key before serialization or not: if enabled, additional sorting 843 step is performed if necessary (not necessary for <a href="http://docs.oracle.com/javase/7/docs/api/java/util/SortedMap.html?is-external=true" title="class or interface in java.util"><code>SortedMap</code></a>s), 844 if disabled, no additional sorting is needed. 845<p> 846 Feature is disabled by default.</div> 847</li> 848</ul> 849<a name="EAGER_SERIALIZER_FETCH"> 850<!-- --> 851</a> 852<ul class="blockList"> 853<li class="blockList"> 854<h4>EAGER_SERIALIZER_FETCH</h4> 855<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> EAGER_SERIALIZER_FETCH</pre> 856<div class="block">Feature that determines whether <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> should 857 try to eagerly fetch necessary <a href="../../../../com/fasterxml/jackson/databind/JsonSerializer.html" title="class in com.fasterxml.jackson.databind"><code>JsonSerializer</code></a> when 858 possible. This improves performance in cases where similarly 859 configured <a href="../../../../com/fasterxml/jackson/databind/ObjectWriter.html" title="class in com.fasterxml.jackson.databind"><code>ObjectWriter</code></a> instance is used multiple 860 times; and should not significantly affect single-use cases. 861<p> 862 Note that there should not be any need to normally disable this 863 feature: only consider that if there are actual perceived problems. 864<p> 865 Feature is enabled by default.</div> 866<dl> 867<dt><span class="simpleTagLabel">Since:</span></dt> 868<dd>2.1</dd> 869</dl> 870</li> 871</ul> 872<a name="USE_EQUALITY_FOR_OBJECT_ID"> 873<!-- --> 874</a> 875<ul class="blockListLast"> 876<li class="blockList"> 877<h4>USE_EQUALITY_FOR_OBJECT_ID</h4> 878<pre>public static final <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> USE_EQUALITY_FOR_OBJECT_ID</pre> 879<div class="block">Feature that determines whether Object Identity is compared using 880 true JVM-level identity of Object (false); or, <code>equals()</code> method. 881 Latter is sometimes useful when dealing with Database-bound objects with 882 ORM libraries (like Hibernate). Note that Object itself is actually compared, 883 and NOT Object Id; naming of this feature is somewhat confusing, so it is important 884 that Object <b>for which identity is to be preserved</b> are considered equal, 885 above and beyond ids (which are always compared using equality anyway). 886<p> 887 NOTE: due to the way functionality is implemented, it is very important that 888 in addition to overriding <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"><code>Object.equals(java.lang.Object)</code></a> for Objects to match (to be considered 889 "same") it is also necessary to ensure that <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"><code>Object.hashCode()</code></a> is overridden 890 to produce the exact same value for equal instances. 891<p> 892 Feature is disabled by default; meaning that strict identity is used, not 893 <code>equals()</code></div> 894<dl> 895<dt><span class="simpleTagLabel">Since:</span></dt> 896<dd>2.3</dd> 897</dl> 898</li> 899</ul> 900</li> 901</ul> 902<!-- ============ METHOD DETAIL ========== --> 903<ul class="blockList"> 904<li class="blockList"><a name="method.detail"> 905<!-- --> 906</a> 907<h3>Method Detail</h3> 908<a name="values--"> 909<!-- --> 910</a> 911<ul class="blockList"> 912<li class="blockList"> 913<h4>values</h4> 914<pre>public static <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a>[] values()</pre> 915<div class="block">Returns an array containing the constants of this enum type, in 916the order they are declared. This method may be used to iterate 917over the constants as follows: 918<pre> 919for (SerializationFeature c : SerializationFeature.values()) 920 System.out.println(c); 921</pre></div> 922<dl> 923<dt><span class="returnLabel">Returns:</span></dt> 924<dd>an array containing the constants of this enum type, in the order they are declared</dd> 925</dl> 926</li> 927</ul> 928<a name="valueOf-java.lang.String-"> 929<!-- --> 930</a> 931<ul class="blockList"> 932<li class="blockList"> 933<h4>valueOf</h4> 934<pre>public static <a href="../../../../com/fasterxml/jackson/databind/SerializationFeature.html" title="enum in com.fasterxml.jackson.databind">SerializationFeature</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> 935<div class="block">Returns the enum constant of this type with the specified name. 936The string must match <i>exactly</i> an identifier used to declare an 937enum constant in this type. (Extraneous whitespace characters are 938not permitted.)</div> 939<dl> 940<dt><span class="paramLabel">Parameters:</span></dt> 941<dd><code>name</code> - the name of the enum constant to be returned.</dd> 942<dt><span class="returnLabel">Returns:</span></dt> 943<dd>the enum constant with the specified name</dd> 944<dt><span class="throwsLabel">Throws:</span></dt> 945<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> 946<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd> 947</dl> 948</li> 949</ul> 950<a name="enabledByDefault--"> 951<!-- --> 952</a> 953<ul class="blockList"> 954<li class="blockList"> 955<h4>enabledByDefault</h4> 956<pre>public boolean enabledByDefault()</pre> 957<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledByDefault--">ConfigFeature</a></code></span></div> 958<div class="block">Accessor for checking whether this feature is enabled by default.</div> 959<dl> 960<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 961<dd><code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledByDefault--">enabledByDefault</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</a></code></dd> 962</dl> 963</li> 964</ul> 965<a name="getMask--"> 966<!-- --> 967</a> 968<ul class="blockList"> 969<li class="blockList"> 970<h4>getMask</h4> 971<pre>public int getMask()</pre> 972<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#getMask--">ConfigFeature</a></code></span></div> 973<div class="block">Returns bit mask for this feature instance</div> 974<dl> 975<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 976<dd><code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#getMask--">getMask</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</a></code></dd> 977</dl> 978</li> 979</ul> 980<a name="enabledIn-int-"> 981<!-- --> 982</a> 983<ul class="blockListLast"> 984<li class="blockList"> 985<h4>enabledIn</h4> 986<pre>public boolean enabledIn(int flags)</pre> 987<div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledIn-int-">ConfigFeature</a></code></span></div> 988<div class="block">Convenience method for checking whether feature is enabled in given bitmask</div> 989<dl> 990<dt><span class="overrideSpecifyLabel">Specified by:</span></dt> 991<dd><code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html#enabledIn-int-">enabledIn</a></code> in interface <code><a href="../../../../com/fasterxml/jackson/databind/cfg/ConfigFeature.html" title="interface in com.fasterxml.jackson.databind.cfg">ConfigFeature</a></code></dd> 992</dl> 993</li> 994</ul> 995</li> 996</ul> 997</li> 998</ul> 999</div> 1000</div> 1001<!-- ========= END OF CLASS DATA ========= --> 1002<!-- ======= START OF BOTTOM NAVBAR ====== --> 1003<div class="bottomNav"><a name="navbar.bottom"> 1004<!-- --> 1005</a> 1006<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 1007<a name="navbar.bottom.firstrow"> 1008<!-- --> 1009</a> 1010<ul class="navList" title="Navigation"> 1011<li><a href="../../../../overview-summary.html">Overview</a></li> 1012<li><a href="package-summary.html">Package</a></li> 1013<li class="navBarCell1Rev">Class</li> 1014<li><a href="class-use/SerializationFeature.html">Use</a></li> 1015<li><a href="package-tree.html">Tree</a></li> 1016<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 1017<li><a href="../../../../index-all.html">Index</a></li> 1018<li><a href="../../../../help-doc.html">Help</a></li> 1019</ul> 1020</div> 1021<div class="subNav"> 1022<ul class="navList"> 1023<li><a href="../../../../com/fasterxml/jackson/databind/SerializationConfig.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Prev Class</span></a></li> 1024<li><a href="../../../../com/fasterxml/jackson/databind/SerializerProvider.html" title="class in com.fasterxml.jackson.databind"><span class="typeNameLink">Next Class</span></a></li> 1025</ul> 1026<ul class="navList"> 1027<li><a href="../../../../index.html?com/fasterxml/jackson/databind/SerializationFeature.html" target="_top">Frames</a></li> 1028<li><a href="SerializationFeature.html" target="_top">No Frames</a></li> 1029</ul> 1030<ul class="navList" id="allclasses_navbar_bottom"> 1031<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 1032</ul> 1033<div> 1034<script type="text/javascript"><!-- 1035 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 1036 if(window==top) { 1037 allClassesLink.style.display = "block"; 1038 } 1039 else { 1040 allClassesLink.style.display = "none"; 1041 } 1042 //--> 1043</script> 1044</div> 1045<div> 1046<ul class="subNavList"> 1047<li>Summary: </li> 1048<li>Nested | </li> 1049<li><a href="#enum.constant.summary">Enum Constants</a> | </li> 1050<li>Field | </li> 1051<li><a href="#method.summary">Method</a></li> 1052</ul> 1053<ul class="subNavList"> 1054<li>Detail: </li> 1055<li><a href="#enum.constant.detail">Enum Constants</a> | </li> 1056<li>Field | </li> 1057<li><a href="#method.detail">Method</a></li> 1058</ul> 1059</div> 1060<a name="skip.navbar.bottom"> 1061<!-- --> 1062</a></div> 1063<!-- ======== END OF BOTTOM NAVBAR ======= --> 1064<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 1065</body> 1066</html> 1067