<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (version 1.7.0_79) on Fri Jan 15 20:28:41 PST 2016 --> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>JsonSerialize.Inclusion (jackson-databind 2.7.0 API)</title> <meta name="date" content="2016-01-15"> <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> </head> <body> <script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="JsonSerialize.Inclusion (jackson-databind 2.7.0 API)"; } //--> </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar_top"> <!-- --> </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/JsonSerialize.Inclusion.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Typing.html" title="enum in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" target="_top">Frames</a></li> <li><a href="JsonSerialize.Inclusion.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#enum_constant_summary">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#enum_constant_detail">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">com.fasterxml.jackson.databind.annotation</div> <h2 title="Enum JsonSerialize.Inclusion" class="title">Enum JsonSerialize.Inclusion</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> <li> <ul class="inheritance"> <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a>></li> <li> <ul class="inheritance"> <li>com.fasterxml.jackson.databind.annotation.JsonSerialize.Inclusion</li> </ul> </li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <dl> <dt>All Implemented Interfaces:</dt> <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a>></dd> </dl> <dl> <dt>Enclosing class:</dt> <dd><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.html" title="annotation in com.fasterxml.jackson.databind.annotation">JsonSerialize</a></dd> </dl> <hr> <div class="block"><strong>Deprecated.</strong></div> <br> <pre><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a> public static enum <span class="strong">JsonSerialize.Inclusion</span> extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a>></pre> <div class="block">Enumeration used with <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.html#include()"><code>JsonSerialize.include()</code></a> property to define which properties of Java Beans are to be included in serialization</div> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- =========== ENUM CONSTANT SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="enum_constant_summary"> <!-- --> </a> <h3>Enum Constant Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> <caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Enum Constant and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#ALWAYS">ALWAYS</a></strong></code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Value that indicates that properties are to be always included, independent of value</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#DEFAULT_INCLUSION">DEFAULT_INCLUSION</a></strong></code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Pseudo-value that is used to indicate "use whatever is default used at higher level".</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#NON_DEFAULT">NON_DEFAULT</a></strong></code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Value that indicates that only properties that have values that differ from default settings (meaning values they have when Bean is constructed with its no-arguments constructor) are to be included.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#NON_EMPTY">NON_EMPTY</a></strong></code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Value that indicates that only properties that have values that values that are null or what is considered empty are not to be included.</div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#NON_NULL">NON_NULL</a></strong></code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Value that indicates that only properties with non-null values are to be included.</div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method_summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span>Methods</span><span class="tabEnd"> </span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr class="altColor"> <td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a></code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Returns the enum constant of this type with the specified name.</div> </td> </tr> <tr class="rowColor"> <td class="colFirst"><code>static <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a>[]</code></td> <td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#values()">values</a></strong>()</code> <div class="block"><strong>Deprecated.</strong> </div> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> <!-- --> </a> <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> </ul> <ul class="blockList"> <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ============ ENUM CONSTANT DETAIL =========== --> <ul class="blockList"> <li class="blockList"><a name="enum_constant_detail"> <!-- --> </a> <h3>Enum Constant Detail</h3> <a name="ALWAYS"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>ALWAYS</h4> <pre>public static final <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> ALWAYS</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Value that indicates that properties are to be always included, independent of value</div> </li> </ul> <a name="NON_NULL"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>NON_NULL</h4> <pre>public static final <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> NON_NULL</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Value that indicates that only properties with non-null values are to be included.</div> </li> </ul> <a name="NON_DEFAULT"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>NON_DEFAULT</h4> <pre>public static final <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> NON_DEFAULT</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Value that indicates that only properties that have values that differ from default settings (meaning values they have when Bean is constructed with its no-arguments constructor) are to be included. Value is generally not useful with <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>s, since they have no default values; and if used, works same as <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html#ALWAYS"><code>ALWAYS</code></a>.</div> </li> </ul> <a name="NON_EMPTY"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>NON_EMPTY</h4> <pre>public static final <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> NON_EMPTY</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Value that indicates that only properties that have values that values that are null or what is considered empty are not to be included. Emptiness is defined for following type: <ul> <li>For <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util"><code>Collection</code></a>s and <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>s, method <code>isEmpty()</code> is called; </li> <li>For Java arrays, empty arrays are ones with length of 0 </li> <li>For Java <a href="http://docs.oracle.com/javase/7/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, and return value of 0 indicates empty String </li> </ul> For other types, non-null values are to be included.</div> </li> </ul> <a name="DEFAULT_INCLUSION"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>DEFAULT_INCLUSION</h4> <pre>public static final <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> DEFAULT_INCLUSION</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Pseudo-value that is used to indicate "use whatever is default used at higher level".</div> <dl><dt><span class="strong">Since:</span></dt> <dd>2.3</dd></dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method_detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="values()"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>values</h4> <pre>public static <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a>[] values()</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows: <pre> for (JsonSerialize.Inclusion c : JsonSerialize.Inclusion.values()) System.out.println(c); </pre></div> <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> </li> </ul> <a name="valueOf(java.lang.String)"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>valueOf</h4> <pre>public static <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" title="enum in com.fasterxml.jackson.databind.annotation">JsonSerialize.Inclusion</a> valueOf(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> <div class="block"><span class="strong">Deprecated.</span> </div> <div class="block">Returns the enum constant of this type with the specified name. The string must match <i>exactly</i> an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)</div> <dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> <dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> <dt><span class="strong">Throws:</span></dt> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar_bottom"> <!-- --> </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../../../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/JsonSerialize.Inclusion.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../../../../deprecated-list.html">Deprecated</a></li> <li><a href="../../../../../index-all.html">Index</a></li> <li><a href="../../../../../help-doc.html">Help</a></li> </ul> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> <li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonSerialize.Typing.html" title="enum in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonSerialize.Inclusion.html" target="_top">Frames</a></li> <li><a href="JsonSerialize.Inclusion.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li><a href="#enum_constant_summary">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method_summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li><a href="#enum_constant_detail">Enum Constants</a> | </li> <li>Field | </li> <li><a href="#method_detail">Method</a></li> </ul> </div> <a name="skip-navbar_bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> </body> </html>