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