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 (version 1.7.0_79) on Tue Jan 23 20:10:06 PST 2018 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>Nulls (Jackson-annotations 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</head> 11<body> 12<script type="text/javascript"><!-- 13 if (location.href.indexOf('is-external=true') == -1) { 14 parent.document.title="Nulls (Jackson-annotations 2.9.0 API)"; 15 } 16//--> 17</script> 18<noscript> 19<div>JavaScript is disabled on your browser.</div> 20</noscript> 21<!-- ========= START OF TOP NAVBAR ======= --> 22<div class="topNav"><a name="navbar_top"> 23<!-- --> 24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 25<!-- --> 26</a> 27<ul class="navList" title="Navigation"> 28<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/Nulls.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../../index-all.html">Index</a></li> 34<li><a href="../../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/Nulls.html" target="_top">Frames</a></li> 44<li><a href="Nulls.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Nested | </li> 65<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 66<li>Field | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 72<li>Field | </li> 73<li><a href="#method_detail">Method</a></li> 74</ul> 75</div> 76<a name="skip-navbar_top"> 77<!-- --> 78</a></div> 79<!-- ========= END OF TOP NAVBAR ========= --> 80<!-- ======== START OF CLASS DATA ======== --> 81<div class="header"> 82<div class="subTitle">com.fasterxml.jackson.annotation</div> 83<h2 title="Enum Nulls" class="title">Enum Nulls</h2> 84</div> 85<div class="contentContainer"> 86<ul class="inheritance"> 87<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 88<li> 89<ul class="inheritance"> 90<li><a href="http://docs.oracle.com/javase/6/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/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a>></li> 91<li> 92<ul class="inheritance"> 93<li>com.fasterxml.jackson.annotation.Nulls</li> 94</ul> 95</li> 96</ul> 97</li> 98</ul> 99<div class="description"> 100<ul class="blockList"> 101<li class="blockList"> 102<dl> 103<dt>All Implemented Interfaces:</dt> 104<dd><a href="http://docs.oracle.com/javase/6/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/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a>></dd> 105</dl> 106<hr> 107<br> 108<pre>public enum <span class="strong">Nulls</span> 109extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a>></pre> 110<div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/annotation/JsonSetter.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonSetter</code></a> (for properties `nulls` 111 and `contentNulls`) 112 to define how explicit `null` values from input (if input format 113 has the concept; JSON, for example does) are handled.</div> 114</li> 115</ul> 116</div> 117<div class="summary"> 118<ul class="blockList"> 119<li class="blockList"> 120<!-- =========== ENUM CONSTANT SUMMARY =========== --> 121<ul class="blockList"> 122<li class="blockList"><a name="enum_constant_summary"> 123<!-- --> 124</a> 125<h3>Enum Constant Summary</h3> 126<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 127<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 128<tr> 129<th class="colOne" scope="col">Enum Constant and Description</th> 130</tr> 131<tr class="altColor"> 132<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#AS_EMPTY">AS_EMPTY</a></strong></code> 133<div class="block">Value that indicates that value to assign should come from the value 134 deserializer of the type, using method <code>getEmptyValue()</code>.</div> 135</td> 136</tr> 137<tr class="rowColor"> 138<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#DEFAULT">DEFAULT</a></strong></code> 139<div class="block">Pseudo-value used to indicate that defaults are to be used for handling, 140 that is, this value specifies no explicit handling override.</div> 141</td> 142</tr> 143<tr class="altColor"> 144<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#FAIL">FAIL</a></strong></code> 145<div class="block">Value that indicates that an exception (of type that indicates input mismatch 146 problem) is to be thrown, to indicate that null values are not accepted.</div> 147</td> 148</tr> 149<tr class="rowColor"> 150<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#SET">SET</a></strong></code> 151<div class="block">Value that indicates that an input null should result in assignment 152 of Java `null` value of matching property (except where deserializer 153 indicates other "null value" by overriding <code>getNullValue(...)</code> 154 method)</div> 155</td> 156</tr> 157<tr class="altColor"> 158<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#SKIP">SKIP</a></strong></code> 159<div class="block">Value that indicates that an input null value should be skipped and 160 no assignment is to be made; this usually means that the property 161 will have its default value.</div> 162</td> 163</tr> 164</table> 165</li> 166</ul> 167<!-- ========== METHOD SUMMARY =========== --> 168<ul class="blockList"> 169<li class="blockList"><a name="method_summary"> 170<!-- --> 171</a> 172<h3>Method Summary</h3> 173<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 174<caption><span>Methods</span><span class="tabEnd"> </span></caption> 175<tr> 176<th class="colFirst" scope="col">Modifier and Type</th> 177<th class="colLast" scope="col">Method and Description</th> 178</tr> 179<tr class="altColor"> 180<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a></code></td> 181<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> 182<div class="block">Returns the enum constant of this type with the specified name.</div> 183</td> 184</tr> 185<tr class="rowColor"> 186<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a>[]</code></td> 187<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/Nulls.html#values()">values</a></strong>()</code> 188<div class="block">Returns an array containing the constants of this enum type, in 189the order they are declared.</div> 190</td> 191</tr> 192</table> 193<ul class="blockList"> 194<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> 195<!-- --> 196</a> 197<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> 198<code><a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> 199</ul> 200<ul class="blockList"> 201<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 202<!-- --> 203</a> 204<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 205<code><a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> 206</ul> 207</li> 208</ul> 209</li> 210</ul> 211</div> 212<div class="details"> 213<ul class="blockList"> 214<li class="blockList"> 215<!-- ============ ENUM CONSTANT DETAIL =========== --> 216<ul class="blockList"> 217<li class="blockList"><a name="enum_constant_detail"> 218<!-- --> 219</a> 220<h3>Enum Constant Detail</h3> 221<a name="SET"> 222<!-- --> 223</a> 224<ul class="blockList"> 225<li class="blockList"> 226<h4>SET</h4> 227<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> SET</pre> 228<div class="block">Value that indicates that an input null should result in assignment 229 of Java `null` value of matching property (except where deserializer 230 indicates other "null value" by overriding <code>getNullValue(...)</code> 231 method)</div> 232</li> 233</ul> 234<a name="SKIP"> 235<!-- --> 236</a> 237<ul class="blockList"> 238<li class="blockList"> 239<h4>SKIP</h4> 240<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> SKIP</pre> 241<div class="block">Value that indicates that an input null value should be skipped and 242 no assignment is to be made; this usually means that the property 243 will have its default value.</div> 244</li> 245</ul> 246<a name="FAIL"> 247<!-- --> 248</a> 249<ul class="blockList"> 250<li class="blockList"> 251<h4>FAIL</h4> 252<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> FAIL</pre> 253<div class="block">Value that indicates that an exception (of type that indicates input mismatch 254 problem) is to be thrown, to indicate that null values are not accepted.</div> 255</li> 256</ul> 257<a name="AS_EMPTY"> 258<!-- --> 259</a> 260<ul class="blockList"> 261<li class="blockList"> 262<h4>AS_EMPTY</h4> 263<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> AS_EMPTY</pre> 264<div class="block">Value that indicates that value to assign should come from the value 265 deserializer of the type, using method <code>getEmptyValue()</code>.</div> 266</li> 267</ul> 268<a name="DEFAULT"> 269<!-- --> 270</a> 271<ul class="blockListLast"> 272<li class="blockList"> 273<h4>DEFAULT</h4> 274<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> DEFAULT</pre> 275<div class="block">Pseudo-value used to indicate that defaults are to be used for handling, 276 that is, this value specifies no explicit handling override.</div> 277</li> 278</ul> 279</li> 280</ul> 281<!-- ============ METHOD DETAIL ========== --> 282<ul class="blockList"> 283<li class="blockList"><a name="method_detail"> 284<!-- --> 285</a> 286<h3>Method Detail</h3> 287<a name="values()"> 288<!-- --> 289</a> 290<ul class="blockList"> 291<li class="blockList"> 292<h4>values</h4> 293<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a>[] values()</pre> 294<div class="block">Returns an array containing the constants of this enum type, in 295the order they are declared. This method may be used to iterate 296over the constants as follows: 297<pre> 298for (Nulls c : Nulls.values()) 299 System.out.println(c); 300</pre></div> 301<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> 302</li> 303</ul> 304<a name="valueOf(java.lang.String)"> 305<!-- --> 306</a> 307<ul class="blockListLast"> 308<li class="blockList"> 309<h4>valueOf</h4> 310<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/Nulls.html" title="enum in com.fasterxml.jackson.annotation">Nulls</a> valueOf(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> 311<div class="block">Returns the enum constant of this type with the specified name. 312The string must match <i>exactly</i> an identifier used to declare an 313enum constant in this type. (Extraneous whitespace characters are 314not permitted.)</div> 315<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> 316<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> 317<dt><span class="strong">Throws:</span></dt> 318<dd><code><a href="http://docs.oracle.com/javase/6/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> 319<dd><code><a href="http://docs.oracle.com/javase/6/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></dl> 320</li> 321</ul> 322</li> 323</ul> 324</li> 325</ul> 326</div> 327</div> 328<!-- ========= END OF CLASS DATA ========= --> 329<!-- ======= START OF BOTTOM NAVBAR ====== --> 330<div class="bottomNav"><a name="navbar_bottom"> 331<!-- --> 332</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 333<!-- --> 334</a> 335<ul class="navList" title="Navigation"> 336<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 337<li class="navBarCell1Rev">Class</li> 338<li><a href="class-use/Nulls.html">Use</a></li> 339<li><a href="package-tree.html">Tree</a></li> 340<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 341<li><a href="../../../../index-all.html">Index</a></li> 342<li><a href="../../../../help-doc.html">Help</a></li> 343</ul> 344</div> 345<div class="subNav"> 346<ul class="navList"> 347<li><a href="../../../../com/fasterxml/jackson/annotation/JsonView.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 348<li><a href="../../../../com/fasterxml/jackson/annotation/ObjectIdGenerator.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 349</ul> 350<ul class="navList"> 351<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/Nulls.html" target="_top">Frames</a></li> 352<li><a href="Nulls.html" target="_top">No Frames</a></li> 353</ul> 354<ul class="navList" id="allclasses_navbar_bottom"> 355<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 356</ul> 357<div> 358<script type="text/javascript"><!-- 359 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 360 if(window==top) { 361 allClassesLink.style.display = "block"; 362 } 363 else { 364 allClassesLink.style.display = "none"; 365 } 366 //--> 367</script> 368</div> 369<div> 370<ul class="subNavList"> 371<li>Summary: </li> 372<li>Nested | </li> 373<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 374<li>Field | </li> 375<li><a href="#method_summary">Method</a></li> 376</ul> 377<ul class="subNavList"> 378<li>Detail: </li> 379<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 380<li>Field | </li> 381<li><a href="#method_detail">Method</a></li> 382</ul> 383</div> 384<a name="skip-navbar_bottom"> 385<!-- --> 386</a></div> 387<!-- ======== END OF BOTTOM NAVBAR ======= --> 388<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 389</body> 390</html> 391