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