• Home
  • 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_10-ea) on Sun Jul 14 20:03:22 PDT 2013 -->
6<title>JsonWriteNullProperties (Jackson JSON Processor)</title>
7<meta name="date" content="2013-07-14">
8<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
9</head>
10<body>
11<script type="text/javascript"><!--
12    if (location.href.indexOf('is-external=true') == -1) {
13        parent.document.title="JsonWriteNullProperties (Jackson JSON Processor)";
14    }
15//-->
16</script>
17<noscript>
18<div>JavaScript is disabled on your browser.</div>
19</noscript>
20<!-- ========= START OF TOP NAVBAR ======= -->
21<div class="topNav"><a name="navbar_top">
22<!--   -->
23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
24<!--   -->
25</a>
26<ul class="navList" title="Navigation">
27<li><a href="../../../../overview-summary.html">Overview</a></li>
28<li><a href="package-summary.html">Package</a></li>
29<li class="navBarCell1Rev">Class</li>
30<li><a href="class-use/JsonWriteNullProperties.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="../../../../org/codehaus/jackson/annotate/JsonValue.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li>
40<li>Next Class</li>
41</ul>
42<ul class="navList">
43<li><a href="../../../../index.html?org/codehaus/jackson/annotate/JsonWriteNullProperties.html" target="_top">Frames</a></li>
44<li><a href="JsonWriteNullProperties.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">org.codehaus.jackson.annotate</div>
79<h2 title="Annotation Type JsonWriteNullProperties" class="title">Annotation Type JsonWriteNullProperties</h2>
80</div>
81<div class="contentContainer">
82<div class="description">
83<ul class="blockList">
84<li class="blockList">
85<hr>
86<div class="block"><strong>Deprecated.</strong>&nbsp;
87<div class="block"><i>(since 1.6) Currently recommended annotation to use is
88 <a href="../../../../org/codehaus/jackson/map/annotate/JsonSerialize.html#include()"><code>JsonSerialize.include()</code></a>
89 (with values <code>ALWAYS</code> or <code>NON_NULL</code>)</i></div>
90</div>
91<br>
92<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#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#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>})
93<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>)
94<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Deprecated.html?is-external=true" title="class or interface in java.lang">@Deprecated</a>
95public @interface <span class="strong">JsonWriteNullProperties</span></pre>
96<div class="block">Annotation that can be used to define whether object properties
97 that have null values are to be written out when serializing
98 content as JSON. This affects Bean and Map serialization.
99<p>
100 Annotation can be used with Classes (all instances of
101 given class) and Methods.
102<p>
103 Default value for this property is 'true', meaning that null
104 properties are written.
105<p></div>
106</li>
107</ul>
108</div>
109<div class="summary">
110<ul class="blockList">
111<li class="blockList">
112<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== -->
113<ul class="blockList">
114<li class="blockList"><a name="annotation_type_optional_element_summary">
115<!--   -->
116</a>
117<h3>Optional Element Summary</h3>
118<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation">
119<caption><span>Optional Elements</span><span class="tabEnd">&nbsp;</span></caption>
120<tr>
121<th class="colFirst" scope="col">Modifier and Type</th>
122<th class="colLast" scope="col">Optional Element and Description</th>
123</tr>
124<tr class="altColor">
125<td class="colFirst"><code>boolean</code></td>
126<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/annotate/JsonWriteNullProperties.html#value()">value</a></strong></code>
127<div class="block"><strong>Deprecated.</strong>&nbsp;</div>
128<div class="block">Whether properties for beans of annotated type will always be
129 written (true), or only if not null (false).</div>
130</td>
131</tr>
132</table>
133</li>
134</ul>
135</li>
136</ul>
137</div>
138<div class="details">
139<ul class="blockList">
140<li class="blockList">
141<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->
142<ul class="blockList">
143<li class="blockList"><a name="annotation_type_element_detail">
144<!--   -->
145</a>
146<h3>Element Detail</h3>
147<a name="value()">
148<!--   -->
149</a>
150<ul class="blockListLast">
151<li class="blockList">
152<h4>value</h4>
153<pre>public abstract&nbsp;boolean&nbsp;value</pre>
154<div class="block"><span class="strong">Deprecated.</span>&nbsp;</div>
155<div class="block">Whether properties for beans of annotated type will always be
156 written (true), or only if not null (false).</div>
157<dl>
158<dt>Default:</dt>
159<dd>true</dd>
160</dl>
161</li>
162</ul>
163</li>
164</ul>
165</li>
166</ul>
167</div>
168</div>
169<!-- ========= END OF CLASS DATA ========= -->
170<!-- ======= START OF BOTTOM NAVBAR ====== -->
171<div class="bottomNav"><a name="navbar_bottom">
172<!--   -->
173</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
174<!--   -->
175</a>
176<ul class="navList" title="Navigation">
177<li><a href="../../../../overview-summary.html">Overview</a></li>
178<li><a href="package-summary.html">Package</a></li>
179<li class="navBarCell1Rev">Class</li>
180<li><a href="class-use/JsonWriteNullProperties.html">Use</a></li>
181<li><a href="package-tree.html">Tree</a></li>
182<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
183<li><a href="../../../../index-all.html">Index</a></li>
184<li><a href="../../../../help-doc.html">Help</a></li>
185</ul>
186</div>
187<div class="subNav">
188<ul class="navList">
189<li><a href="../../../../org/codehaus/jackson/annotate/JsonValue.html" title="annotation in org.codehaus.jackson.annotate"><span class="strong">Prev Class</span></a></li>
190<li>Next Class</li>
191</ul>
192<ul class="navList">
193<li><a href="../../../../index.html?org/codehaus/jackson/annotate/JsonWriteNullProperties.html" target="_top">Frames</a></li>
194<li><a href="JsonWriteNullProperties.html" target="_top">No Frames</a></li>
195</ul>
196<ul class="navList" id="allclasses_navbar_bottom">
197<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
198</ul>
199<div>
200<script type="text/javascript"><!--
201  allClassesLink = document.getElementById("allclasses_navbar_bottom");
202  if(window==top) {
203    allClassesLink.style.display = "block";
204  }
205  else {
206    allClassesLink.style.display = "none";
207  }
208  //-->
209</script>
210</div>
211<div>
212<ul class="subNavList">
213<li>Summary:&nbsp;</li>
214<li>Required&nbsp;|&nbsp;</li>
215<li><a href="#annotation_type_optional_element_summary">Optional</a></li>
216</ul>
217<ul class="subNavList">
218<li>Detail:&nbsp;</li>
219<li><a href="#annotation_type_element_detail">Element</a></li>
220</ul>
221</div>
222<a name="skip-navbar_bottom">
223<!--   -->
224</a></div>
225<!-- ======== END OF BOTTOM NAVBAR ======= -->
226</body>
227</html>
228