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 Wed Jul 20 08:39:10 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonAppend.Prop (jackson-databind 2.8.0 API)</title> 8<meta name="date" content="2016-07-20"> 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="JsonAppend.Prop (jackson-databind 2.8.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="../../../../../overview-summary.html">Overview</a></li> 29<li><a href="package-summary.html">Package</a></li> 30<li class="navBarCell1Rev">Class</li> 31<li><a href="class-use/JsonAppend.Prop.html">Use</a></li> 32<li><a href="package-tree.html">Tree</a></li> 33<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 34<li><a href="../../../../../index-all.html">Index</a></li> 35<li><a href="../../../../../help-doc.html">Help</a></li> 36</ul> 37</div> 38<div class="subNav"> 39<ul class="navList"> 40<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> 41<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> 42</ul> 43<ul class="navList"> 44<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html" target="_top">Frames</a></li> 45<li><a href="JsonAppend.Prop.html" target="_top">No Frames</a></li> 46</ul> 47<ul class="navList" id="allclasses_navbar_top"> 48<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 49</ul> 50<div> 51<script type="text/javascript"><!-- 52 allClassesLink = document.getElementById("allclasses_navbar_top"); 53 if(window==top) { 54 allClassesLink.style.display = "block"; 55 } 56 else { 57 allClassesLink.style.display = "none"; 58 } 59 //--> 60</script> 61</div> 62<div> 63<ul class="subNavList"> 64<li>Summary: </li> 65<li><a href="#annotation_type_required_element_summary">Required</a> | </li> 66<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 67</ul> 68<ul class="subNavList"> 69<li>Detail: </li> 70<li><a href="#annotation_type_element_detail">Element</a></li> 71</ul> 72</div> 73<a name="skip-navbar_top"> 74<!-- --> 75</a></div> 76<!-- ========= END OF TOP NAVBAR ========= --> 77<!-- ======== START OF CLASS DATA ======== --> 78<div class="header"> 79<div class="subTitle">com.fasterxml.jackson.databind.annotation</div> 80<h2 title="Annotation Type JsonAppend.Prop" class="title">Annotation Type JsonAppend.Prop</h2> 81</div> 82<div class="contentContainer"> 83<div class="description"> 84<ul class="blockList"> 85<li class="blockList"> 86<hr> 87<br> 88<pre>public static @interface <span class="strong">JsonAppend.Prop</span></pre> 89<div class="block">Definition of a single general virtual property.</div> 90</li> 91</ul> 92</div> 93<div class="summary"> 94<ul class="blockList"> 95<li class="blockList"> 96<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 97<ul class="blockList"> 98<li class="blockList"><a name="annotation_type_required_element_summary"> 99<!-- --> 100</a> 101<h3>Required Element Summary</h3> 102<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> 103<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> 104<tr> 105<th class="colFirst" scope="col">Modifier and Type</th> 106<th class="colLast" scope="col">Required Element and Description</th> 107</tr> 108<tr class="altColor"> 109<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a>></code></td> 110<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#value()">value</a></strong></code> 111<div class="block">Actual implementation class (a subtype of <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>VirtualBeanPropertyWriter</code></a>) 112 of the property to instantiate (using the no-argument default constructor).</div> 113</td> 114</tr> 115</table> 116</li> 117</ul> 118<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 119<ul class="blockList"> 120<li class="blockList"><a name="annotation_type_optional_element_summary"> 121<!-- --> 122</a> 123<h3>Optional Element Summary</h3> 124<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 125<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 126<tr> 127<th class="colFirst" scope="col">Modifier and Type</th> 128<th class="colLast" scope="col">Optional Element and Description</th> 129</tr> 130<tr class="altColor"> 131<td class="colFirst"><code><a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td> 132<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#include()">include</a></strong></code> 133<div class="block">When to include value of the property.</div> 134</td> 135</tr> 136<tr class="rowColor"> 137<td class="colFirst"><code><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></code></td> 138<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()">name</a></strong></code> 139<div class="block">Name of the property to possibly use for serializing (although implementation 140 may choose to not use this information).</div> 141</td> 142</tr> 143<tr class="altColor"> 144<td class="colFirst"><code><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></code></td> 145<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#namespace()">namespace</a></strong></code> 146<div class="block">Optional namespace to use along with <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()"><code>name()</code></a>; 147 only relevant for data formats that use namespaces (like XML).</div> 148</td> 149</tr> 150<tr class="rowColor"> 151<td class="colFirst"><code>boolean</code></td> 152<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#required()">required</a></strong></code> 153<div class="block">Metadata about property, similar to 154 <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonProperty.html?is-external=true#required()" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonProperty.required()</code></a>.</div> 155</td> 156</tr> 157<tr class="altColor"> 158<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?></code></td> 159<td class="colLast"><code><strong><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#type()">type</a></strong></code> 160<div class="block">Nominal type of the property.</div> 161</td> 162</tr> 163</table> 164</li> 165</ul> 166</li> 167</ul> 168</div> 169<div class="details"> 170<ul class="blockList"> 171<li class="blockList"> 172<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 173<ul class="blockList"> 174<li class="blockList"><a name="annotation_type_element_detail"> 175<!-- --> 176</a> 177<h3>Element Detail</h3> 178<a name="value()"> 179<!-- --> 180</a> 181<ul class="blockListLast"> 182<li class="blockList"> 183<h4>value</h4> 184<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><? extends <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser">VirtualBeanPropertyWriter</a>> value</pre> 185<div class="block">Actual implementation class (a subtype of <a href="../../../../../com/fasterxml/jackson/databind/ser/VirtualBeanPropertyWriter.html" title="class in com.fasterxml.jackson.databind.ser"><code>VirtualBeanPropertyWriter</code></a>) 186 of the property to instantiate (using the no-argument default constructor).</div> 187</li> 188</ul> 189<a name="name()"> 190<!-- --> 191</a> 192<ul class="blockList"> 193<li class="blockList"> 194<h4>name</h4> 195<pre>public abstract <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> 196<div class="block">Name of the property to possibly use for serializing (although implementation 197 may choose to not use this information).</div> 198<dl> 199<dt>Default:</dt> 200<dd>""</dd> 201</dl> 202</li> 203</ul> 204<a name="namespace()"> 205<!-- --> 206</a> 207<ul class="blockList"> 208<li class="blockList"> 209<h4>namespace</h4> 210<pre>public abstract <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> namespace</pre> 211<div class="block">Optional namespace to use along with <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html#name()"><code>name()</code></a>; 212 only relevant for data formats that use namespaces (like XML).</div> 213<dl> 214<dt>Default:</dt> 215<dd>""</dd> 216</dl> 217</li> 218</ul> 219<a name="include()"> 220<!-- --> 221</a> 222<ul class="blockList"> 223<li class="blockList"> 224<h4>include</h4> 225<pre>public abstract <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a> include</pre> 226<div class="block">When to include value of the property. Default value indicates that 227 property should only be written if specified attribute has a non-null 228 value. As with other properties, actual property implementation may or may 229 not choose to use this inclusion information.</div> 230<dl> 231<dt>Default:</dt> 232<dd>com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL</dd> 233</dl> 234</li> 235</ul> 236<a name="required()"> 237<!-- --> 238</a> 239<ul class="blockList"> 240<li class="blockList"> 241<h4>required</h4> 242<pre>public abstract boolean required</pre> 243<div class="block">Metadata about property, similar to 244 <a href="http://fasterxml.github.com/jackson-annotations/javadoc/2.7/com/fasterxml/jackson/annotation/JsonProperty.html?is-external=true#required()" title="class or interface in com.fasterxml.jackson.annotation"><code>JsonProperty.required()</code></a>.</div> 245<dl> 246<dt>Default:</dt> 247<dd>false</dd> 248</dl> 249</li> 250</ul> 251<a name="type()"> 252<!-- --> 253</a> 254<ul class="blockListLast"> 255<li class="blockList"> 256<h4>type</h4> 257<pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><?> type</pre> 258<div class="block">Nominal type of the property. Passed as type information for related 259 virtual objects, and may (or may not be) used by implementation 260 for choosing serializer to use.</div> 261<dl> 262<dt>Default:</dt> 263<dd>java.lang.Object.class</dd> 264</dl> 265</li> 266</ul> 267</li> 268</ul> 269</li> 270</ul> 271</div> 272</div> 273<!-- ========= END OF CLASS DATA ========= --> 274<!-- ======= START OF BOTTOM NAVBAR ====== --> 275<div class="bottomNav"><a name="navbar_bottom"> 276<!-- --> 277</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 278<!-- --> 279</a> 280<ul class="navList" title="Navigation"> 281<li><a href="../../../../../overview-summary.html">Overview</a></li> 282<li><a href="package-summary.html">Package</a></li> 283<li class="navBarCell1Rev">Class</li> 284<li><a href="class-use/JsonAppend.Prop.html">Use</a></li> 285<li><a href="package-tree.html">Tree</a></li> 286<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 287<li><a href="../../../../../index-all.html">Index</a></li> 288<li><a href="../../../../../help-doc.html">Help</a></li> 289</ul> 290</div> 291<div class="subNav"> 292<ul class="navList"> 293<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Prev Class</span></a></li> 294<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonDeserialize.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="strong">Next Class</span></a></li> 295</ul> 296<ul class="navList"> 297<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html" target="_top">Frames</a></li> 298<li><a href="JsonAppend.Prop.html" target="_top">No Frames</a></li> 299</ul> 300<ul class="navList" id="allclasses_navbar_bottom"> 301<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 302</ul> 303<div> 304<script type="text/javascript"><!-- 305 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 306 if(window==top) { 307 allClassesLink.style.display = "block"; 308 } 309 else { 310 allClassesLink.style.display = "none"; 311 } 312 //--> 313</script> 314</div> 315<div> 316<ul class="subNavList"> 317<li>Summary: </li> 318<li><a href="#annotation_type_required_element_summary">Required</a> | </li> 319<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 320</ul> 321<ul class="subNavList"> 322<li>Detail: </li> 323<li><a href="#annotation_type_element_detail">Element</a></li> 324</ul> 325</div> 326<a name="skip-navbar_bottom"> 327<!-- --> 328</a></div> 329<!-- ======== END OF BOTTOM NAVBAR ======= --> 330<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 331</body> 332</html> 333