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