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>JsonInclude.Include (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="JsonInclude.Include (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/JsonInclude.Include.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/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.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/JsonInclude.Include.html" target="_top">Frames</a></li> 44<li><a href="JsonInclude.Include.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 JsonInclude.Include" class="title">Enum JsonInclude.Include</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/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>></li> 91<li> 92<ul class="inheritance"> 93<li>com.fasterxml.jackson.annotation.JsonInclude.Include</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/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>></dd> 105</dl> 106<dl> 107<dt>Enclosing class:</dt> 108<dd><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation">JsonInclude</a></dd> 109</dl> 110<hr> 111<br> 112<pre>public static enum <span class="strong">JsonInclude.Include</span> 113extends <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/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>></pre> 114<div class="block">Enumeration used with <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><code>JsonInclude</code></a> 115 to define which properties 116 of Java Beans are to be included in serialization.</div> 117</li> 118</ul> 119</div> 120<div class="summary"> 121<ul class="blockList"> 122<li class="blockList"> 123<!-- =========== ENUM CONSTANT SUMMARY =========== --> 124<ul class="blockList"> 125<li class="blockList"><a name="enum_constant_summary"> 126<!-- --> 127</a> 128<h3>Enum Constant Summary</h3> 129<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 130<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 131<tr> 132<th class="colOne" scope="col">Enum Constant and Description</th> 133</tr> 134<tr class="altColor"> 135<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#ALWAYS">ALWAYS</a></strong></code> 136<div class="block">Value that indicates that property is to be always included, 137 independent of value of the property.</div> 138</td> 139</tr> 140<tr class="rowColor"> 141<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#CUSTOM">CUSTOM</a></strong></code> 142<div class="block">Value that indicates that separate `filter` Object (specified by 143 <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#valueFilter()"><code>JsonInclude.valueFilter()</code></a> for value itself, and/or 144 <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#contentFilter()"><code>JsonInclude.contentFilter()</code></a> for contents of structured types) 145 is to be used for determining inclusion criteria.</div> 146</td> 147</tr> 148<tr class="altColor"> 149<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_ABSENT">NON_ABSENT</a></strong></code> 150<div class="block">Value that indicates that properties are included unless their value 151 is: 152 153 null 154 "absent" value of a referential type (like Java 8 `Optional`, or 155 {link java.utl.concurrent.atomic.AtomicReference}); that is, something 156 that would not deference to a non-null value.</div> 157</td> 158</tr> 159<tr class="rowColor"> 160<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_DEFAULT">NON_DEFAULT</a></strong></code> 161<div class="block">Meaning of this setting depends on context: whether annotation is 162 specified for POJO type (class), or not.</div> 163</td> 164</tr> 165<tr class="altColor"> 166<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_EMPTY">NON_EMPTY</a></strong></code> 167<div class="block">Value that indicates that only properties with null value, 168 or what is considered empty, are not to be included.</div> 169</td> 170</tr> 171<tr class="rowColor"> 172<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_NULL">NON_NULL</a></strong></code> 173<div class="block">Value that indicates that only properties with non-null 174 values are to be included.</div> 175</td> 176</tr> 177<tr class="altColor"> 178<td class="colOne"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#USE_DEFAULTS">USE_DEFAULTS</a></strong></code> 179<div class="block">Pseudo-value used to indicate that the higher-level defaults make 180 sense, to avoid overriding inclusion value.</div> 181</td> 182</tr> 183</table> 184</li> 185</ul> 186<!-- ========== METHOD SUMMARY =========== --> 187<ul class="blockList"> 188<li class="blockList"><a name="method_summary"> 189<!-- --> 190</a> 191<h3>Method Summary</h3> 192<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 193<caption><span>Methods</span><span class="tabEnd"> </span></caption> 194<tr> 195<th class="colFirst" scope="col">Modifier and Type</th> 196<th class="colLast" scope="col">Method and Description</th> 197</tr> 198<tr class="altColor"> 199<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td> 200<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.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> 201<div class="block">Returns the enum constant of this type with the specified name.</div> 202</td> 203</tr> 204<tr class="rowColor"> 205<td class="colFirst"><code>static <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>[]</code></td> 206<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#values()">values</a></strong>()</code> 207<div class="block">Returns an array containing the constants of this enum type, in 208the order they are declared.</div> 209</td> 210</tr> 211</table> 212<ul class="blockList"> 213<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> 214<!-- --> 215</a> 216<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> 217<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> 218</ul> 219<ul class="blockList"> 220<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 221<!-- --> 222</a> 223<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> 224<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> 225</ul> 226</li> 227</ul> 228</li> 229</ul> 230</div> 231<div class="details"> 232<ul class="blockList"> 233<li class="blockList"> 234<!-- ============ ENUM CONSTANT DETAIL =========== --> 235<ul class="blockList"> 236<li class="blockList"><a name="enum_constant_detail"> 237<!-- --> 238</a> 239<h3>Enum Constant Detail</h3> 240<a name="ALWAYS"> 241<!-- --> 242</a> 243<ul class="blockList"> 244<li class="blockList"> 245<h4>ALWAYS</h4> 246<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> ALWAYS</pre> 247<div class="block">Value that indicates that property is to be always included, 248 independent of value of the property.</div> 249</li> 250</ul> 251<a name="NON_NULL"> 252<!-- --> 253</a> 254<ul class="blockList"> 255<li class="blockList"> 256<h4>NON_NULL</h4> 257<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> NON_NULL</pre> 258<div class="block">Value that indicates that only properties with non-null 259 values are to be included.</div> 260</li> 261</ul> 262<a name="NON_ABSENT"> 263<!-- --> 264</a> 265<ul class="blockList"> 266<li class="blockList"> 267<h4>NON_ABSENT</h4> 268<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> NON_ABSENT</pre> 269<div class="block">Value that indicates that properties are included unless their value 270 is: 271<ul> 272 <li>null</li> 273 <li>"absent" value of a referential type (like Java 8 `Optional`, or 274 {link java.utl.concurrent.atomic.AtomicReference}); that is, something 275 that would not deference to a non-null value. 276 </ul> 277 This option is mostly used to work with "Optional"s (Java 8, Guava).</div> 278<dl><dt><span class="strong">Since:</span></dt> 279 <dd>2.6</dd></dl> 280</li> 281</ul> 282<a name="NON_EMPTY"> 283<!-- --> 284</a> 285<ul class="blockList"> 286<li class="blockList"> 287<h4>NON_EMPTY</h4> 288<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> NON_EMPTY</pre> 289<div class="block">Value that indicates that only properties with null value, 290 or what is considered empty, are not to be included. 291 Definition of emptiness is data type specific; see below 292 for details on actual handling. 293<p> 294 Default emptiness for all types includes: 295<ul> 296 <li><code>Null</code> values.</li> 297 <li>"Absent" values (see <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_ABSENT"><code>NON_ABSENT</code></a>)</li> 298</ul> 299 so that as baseline, "empty" set includes values that would be 300 excluded by both <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_NULL"><code>NON_NULL</code></a> and <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_ABSENT"><code>NON_ABSENT</code></a>. 301<br> 302 Beyond this base, following types have additional empty values: 303<ul> 304 <li>For <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>s and <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>s, 305 method <code>isEmpty()</code> is called; 306 </li> 307 <li>For Java arrays, empty arrays are ones with length of 0 308 </li> 309 <li>For Java <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang"><code>String</code></a>s, <code>length()</code> is called, 310 and return value of 0 indicates empty String 311 </li> 312 </ul> 313 and for other types, null values are excluded but other exclusions (if any). 314<p> 315 Note that this default handling can be overridden by custom 316 <code>JsonSerializer</code> implementation: if method <code>isEmpty()</code> 317 is overridden, it will be called to see if non-null values are 318 considered empty (null is always considered empty). 319<p> 320 Compatibility note: Jackson 2.6 included a wider range of "empty" values than 321 either earlier (up to 2.5) or later (2.7 and beyond) types; specifically: 322<ul> 323 <li>Default values of primitive types (like <code>0</code> for `int`/`java.lang.Integer` 324 and `false` for `bool`/`Boolean`) 325 </li> 326 <li>Timestamp 0 for date/time types 327 </li> 328</ul> 329 With 2.7, definition has been tightened back to only containing types explained 330 above (null, absent, empty String, empty containers), and now 331 extended definition may be specified using <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_DEFAULT"><code>NON_DEFAULT</code></a>.</div> 332</li> 333</ul> 334<a name="NON_DEFAULT"> 335<!-- --> 336</a> 337<ul class="blockList"> 338<li class="blockList"> 339<h4>NON_DEFAULT</h4> 340<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> NON_DEFAULT</pre> 341<div class="block">Meaning of this setting depends on context: whether annotation is 342 specified for POJO type (class), or not. In latter case annotation 343 is either used as the global default, or as property override. 344<p> 345 When used for a POJO, definition is that only values that differ from 346 the default values of POJO properties are included. This is done 347 by creating an instance of POJO using zero-argument constructor, 348 and accessing property values: value is used as the default value 349 by using <code>equals()</code> method, except for the case where property 350 has `null` value in which case straight null check is used. 351<p> 352 When NOT used for a POJO (that is, as a global default, or as property 353 override), definition is such that: 354<ul> 355 <li>All values considered "empty" (as per <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_EMPTY"><code>NON_EMPTY</code></a>) are excluded</li> 356 <li>Primitive/wrapper default values are excluded</li> 357 <li>Date/time values that have timestamp (`long` value of milliseconds since 358 epoch, see <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Date.html?is-external=true" title="class or interface in java.util"><code>Date</code></a>) of `0L` are excluded</li> 359 </ul></div> 360</li> 361</ul> 362<a name="CUSTOM"> 363<!-- --> 364</a> 365<ul class="blockList"> 366<li class="blockList"> 367<h4>CUSTOM</h4> 368<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> CUSTOM</pre> 369<div class="block">Value that indicates that separate `filter` Object (specified by 370 <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#valueFilter()"><code>JsonInclude.valueFilter()</code></a> for value itself, and/or 371 <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#contentFilter()"><code>JsonInclude.contentFilter()</code></a> for contents of structured types) 372 is to be used for determining inclusion criteria. 373 Filter object's <code>equals()</code> method is called with value 374 to serialize; if it returns <code>true</code> value is <b>excluded</b> 375 (that is, filtered out); if <code>false</code> value is <b>included</b>.</div> 376<dl><dt><span class="strong">Since:</span></dt> 377 <dd>2.9</dd></dl> 378</li> 379</ul> 380<a name="USE_DEFAULTS"> 381<!-- --> 382</a> 383<ul class="blockListLast"> 384<li class="blockList"> 385<h4>USE_DEFAULTS</h4> 386<pre>public static final <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a> USE_DEFAULTS</pre> 387<div class="block">Pseudo-value used to indicate that the higher-level defaults make 388 sense, to avoid overriding inclusion value. For example, if returned 389 for a property this would use defaults for the class that contains 390 property, if any defined; and if none defined for that, then 391 global serialization inclusion details.</div> 392<dl><dt><span class="strong">Since:</span></dt> 393 <dd>2.6</dd></dl> 394</li> 395</ul> 396</li> 397</ul> 398<!-- ============ METHOD DETAIL ========== --> 399<ul class="blockList"> 400<li class="blockList"><a name="method_detail"> 401<!-- --> 402</a> 403<h3>Method Detail</h3> 404<a name="values()"> 405<!-- --> 406</a> 407<ul class="blockList"> 408<li class="blockList"> 409<h4>values</h4> 410<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>[] values()</pre> 411<div class="block">Returns an array containing the constants of this enum type, in 412the order they are declared. This method may be used to iterate 413over the constants as follows: 414<pre> 415for (JsonInclude.Include c : JsonInclude.Include.values()) 416 System.out.println(c); 417</pre></div> 418<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> 419</li> 420</ul> 421<a name="valueOf(java.lang.String)"> 422<!-- --> 423</a> 424<ul class="blockListLast"> 425<li class="blockList"> 426<h4>valueOf</h4> 427<pre>public static <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</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> 428<div class="block">Returns the enum constant of this type with the specified name. 429The string must match <i>exactly</i> an identifier used to declare an 430enum constant in this type. (Extraneous whitespace characters are 431not permitted.)</div> 432<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> 433<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> 434<dt><span class="strong">Throws:</span></dt> 435<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> 436<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> 437</li> 438</ul> 439</li> 440</ul> 441</li> 442</ul> 443</div> 444</div> 445<!-- ========= END OF CLASS DATA ========= --> 446<!-- ======= START OF BOTTOM NAVBAR ====== --> 447<div class="bottomNav"><a name="navbar_bottom"> 448<!-- --> 449</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 450<!-- --> 451</a> 452<ul class="navList" title="Navigation"> 453<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 454<li class="navBarCell1Rev">Class</li> 455<li><a href="class-use/JsonInclude.Include.html">Use</a></li> 456<li><a href="package-tree.html">Tree</a></li> 457<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 458<li><a href="../../../../index-all.html">Index</a></li> 459<li><a href="../../../../help-doc.html">Help</a></li> 460</ul> 461</div> 462<div class="subNav"> 463<ul class="navList"> 464<li><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 465<li><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Value.html" title="class in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 466</ul> 467<ul class="navList"> 468<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonInclude.Include.html" target="_top">Frames</a></li> 469<li><a href="JsonInclude.Include.html" target="_top">No Frames</a></li> 470</ul> 471<ul class="navList" id="allclasses_navbar_bottom"> 472<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 473</ul> 474<div> 475<script type="text/javascript"><!-- 476 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 477 if(window==top) { 478 allClassesLink.style.display = "block"; 479 } 480 else { 481 allClassesLink.style.display = "none"; 482 } 483 //--> 484</script> 485</div> 486<div> 487<ul class="subNavList"> 488<li>Summary: </li> 489<li>Nested | </li> 490<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 491<li>Field | </li> 492<li><a href="#method_summary">Method</a></li> 493</ul> 494<ul class="subNavList"> 495<li>Detail: </li> 496<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 497<li>Field | </li> 498<li><a href="#method_detail">Method</a></li> 499</ul> 500</div> 501<a name="skip-navbar_bottom"> 502<!-- --> 503</a></div> 504<!-- ======== END OF BOTTOM NAVBAR ======= --> 505<p class="legalCopy"><small>Copyright © 2008–2018 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 506</body> 507</html> 508