• Home
  • History
  • Annotate
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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_67) on Thu Jul 16 17:03:17 PDT 2015 -->
6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
7<title>JsonInclude (Jackson-annotations 2.6.0 API)</title>
8<meta name="date" content="2015-07-16">
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 (Jackson-annotations 2.6.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.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/JsonIgnoreType.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.Include.html" title="enum 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.html" target="_top">Frames</a></li>
44<li><a href="JsonInclude.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:&nbsp;</li>
64<li>Required&nbsp;|&nbsp;</li>
65<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
66</ul>
67<ul class="subNavList">
68<li>Detail:&nbsp;</li>
69<li><a href="#annotation_type_element_detail">Element</a></li>
70</ul>
71</div>
72<a name="skip-navbar_top">
73<!--   -->
74</a></div>
75<!-- ========= END OF TOP NAVBAR ========= -->
76<!-- ======== START OF CLASS DATA ======== -->
77<div class="header">
78<div class="subTitle">com.fasterxml.jackson.annotation</div>
79<h2 title="Annotation Type JsonInclude" class="title">Annotation Type JsonInclude</h2>
80</div>
81<div class="contentContainer">
82<div class="description">
83<ul class="blockList">
84<li class="blockList">
85<hr>
86<br>
87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#TYPE" title="class or interface in java.lang.annotation">TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</a>})
88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>)
89public @interface <span class="strong">JsonInclude</span></pre>
90<div class="block">Annotation used to indicate when value of the annotated property (when
91 used for a field, method or constructor parameter), or all
92 properties of the annotated class, is to be serialized.
93 Without annotation property values are always included, but by using
94 this annotation one can specify simple exclusion rules to reduce
95 amount of properties to write out.
96<p>
97 Note that inclusion criteria is checked on <b>Java object level</b>
98 and <b>NOT</b> on JSON output -- so even with <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_NULL"><code>JsonInclude.Include.NON_NULL</code></a>
99 it is possible that JSON null values are output, if object reference
100 in question is not `null`. An example is <a href="http://docs.oracle.com/javase/6/docs/api/java/util/concurrent/atomic/AtomicReference.html?is-external=true" title="class or interface in java.util.concurrent.atomic"><code>AtomicReference</code></a>
101 instance constructed to reference <code>null</code> value: such a value
102 would be serialized as JSON null, and not filtered out.
103 In such cases <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_EMPTY"><code>JsonInclude.Include.NON_EMPTY</code></a> should be used instead, since missing
104 reference (that is, reference to Java null) is considered "empty" (it is also
105 considered "default", so match <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#NON_DEFAULT"><code>JsonInclude.Include.NON_DEFAULT</code></a>).</div>
106<dl><dt><span class="strong">Since:</span></dt>
107  <dd>2.0</dd></dl>
108</li>
109</ul>
110</div>
111<div class="summary">
112<ul class="blockList">
113<li class="blockList">
114<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
115<ul class="blockList">
116<li class="blockList"><a name="annotation_type_optional_element_summary">
117<!--   -->
118</a>
119<h3>Optional Element Summary</h3>
120<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
121<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
122<tr>
123<th class="colFirst" scope="col">Modifier and Type</th>
124<th class="colLast" scope="col">Optional Element and Description</th>
125</tr>
126<tr class="altColor">
127<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td>
128<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#content()">content</a></strong></code>
129<div class="block">Inclusion rule to use for entries ("content") of annotated
130 <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; defaults to <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#ALWAYS"><code>JsonInclude.Include.ALWAYS</code></a>.</div>
131</td>
132</tr>
133<tr class="rowColor">
134<td class="colFirst"><code><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td>
135<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.html#value()">value</a></strong></code>
136<div class="block">Inclusion rule to use for instances (values) of types (Classes) or
137 properties annotated.</div>
138</td>
139</tr>
140</table>
141</li>
142</ul>
143</li>
144</ul>
145</div>
146<div class="details">
147<ul class="blockList">
148<li class="blockList">
149<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
150<ul class="blockList">
151<li class="blockList"><a name="annotation_type_element_detail">
152<!--   -->
153</a>
154<h3>Element Detail</h3>
155<a name="value()">
156<!--   -->
157</a>
158<ul class="blockList">
159<li class="blockList">
160<h4>value</h4>
161<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>&nbsp;value</pre>
162<div class="block">Inclusion rule to use for instances (values) of types (Classes) or
163 properties annotated.</div>
164<dl>
165<dt>Default:</dt>
166<dd>com.fasterxml.jackson.annotation.JsonInclude.Include.ALWAYS</dd>
167</dl>
168</li>
169</ul>
170<a name="content()">
171<!--   -->
172</a>
173<ul class="blockListLast">
174<li class="blockList">
175<h4>content</h4>
176<pre>public abstract&nbsp;<a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation">JsonInclude.Include</a>&nbsp;content</pre>
177<div class="block">Inclusion rule to use for entries ("content") of annotated
178 <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; defaults to <a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html#ALWAYS"><code>JsonInclude.Include.ALWAYS</code></a>.</div>
179<dl><dt><span class="strong">Since:</span></dt>
180  <dd>2.5</dd></dl>
181<dl>
182<dt>Default:</dt>
183<dd>com.fasterxml.jackson.annotation.JsonInclude.Include.ALWAYS</dd>
184</dl>
185</li>
186</ul>
187</li>
188</ul>
189</li>
190</ul>
191</div>
192</div>
193<!-- ========= END OF CLASS DATA ========= -->
194<!-- ======= START OF BOTTOM NAVBAR ====== -->
195<div class="bottomNav"><a name="navbar_bottom">
196<!--   -->
197</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
198<!--   -->
199</a>
200<ul class="navList" title="Navigation">
201<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li>
202<li class="navBarCell1Rev">Class</li>
203<li><a href="class-use/JsonInclude.html">Use</a></li>
204<li><a href="package-tree.html">Tree</a></li>
205<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
206<li><a href="../../../../index-all.html">Index</a></li>
207<li><a href="../../../../help-doc.html">Help</a></li>
208</ul>
209</div>
210<div class="subNav">
211<ul class="navList">
212<li><a href="../../../../com/fasterxml/jackson/annotation/JsonIgnoreType.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li>
213<li><a href="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li>
214</ul>
215<ul class="navList">
216<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonInclude.html" target="_top">Frames</a></li>
217<li><a href="JsonInclude.html" target="_top">No Frames</a></li>
218</ul>
219<ul class="navList" id="allclasses_navbar_bottom">
220<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
221</ul>
222<div>
223<script type="text/javascript"><!--
224  allClassesLink = document.getElementById("allclasses_navbar_bottom");
225  if(window==top) {
226    allClassesLink.style.display = "block";
227  }
228  else {
229    allClassesLink.style.display = "none";
230  }
231  //-->
232</script>
233</div>
234<div>
235<ul class="subNavList">
236<li>Summary:&nbsp;</li>
237<li>Required&nbsp;|&nbsp;</li>
238<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
239</ul>
240<ul class="subNavList">
241<li>Detail:&nbsp;</li>
242<li><a href="#annotation_type_element_detail">Element</a></li>
243</ul>
244</div>
245<a name="skip-navbar_bottom">
246<!--   -->
247</a></div>
248<!-- ======== END OF BOTTOM NAVBAR ======= -->
249<p class="legalCopy"><small>Copyright &#169; 2014&#x2013;2015 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p>
250</body>
251</html>
252