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 Sat Apr 25 17:14:51 PDT 2020 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonAppend.Attr (jackson-databind 2.11.0 API)</title> 8<meta name="date" content="2020-04-25"> 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.Attr (jackson-databind 2.11.0 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.Attr.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.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/JsonAppend.Prop.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.Attr.html" target="_top">Frames</a></li> 52<li><a href="JsonAppend.Attr.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.Attr" class="title">Annotation Type JsonAppend.Attr</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.Attr</span></pre> 98<div class="block">Definition of a single attribute-backed property. 99 Attribute-backed properties will be appended after (or prepended before, 100 as per <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.html#prepend--"><code>JsonAppend.prepend()</code></a>) regular properties 101 in specified order, although their placement may be further changed 102 by the usual property-ordering functionality (alphabetic sorting; 103 explicit ordering)</div> 104</li> 105</ul> 106</div> 107<div class="summary"> 108<ul class="blockList"> 109<li class="blockList"> 110<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== --> 111<ul class="blockList"> 112<li class="blockList"><a name="annotation.type.required.element.summary"> 113<!-- --> 114</a> 115<h3>Required Element Summary</h3> 116<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Required Element Summary table, listing required elements, and an explanation"> 117<caption><span>Required Elements</span><span class="tabEnd"> </span></caption> 118<tr> 119<th class="colFirst" scope="col">Modifier and Type</th> 120<th class="colLast" scope="col">Required Element and Description</th> 121</tr> 122<tr class="altColor"> 123<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> 124<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#value--">value</a></span></code> 125<div class="block">Name of attribute of which value to serialize.</div> 126</td> 127</tr> 128</table> 129</li> 130</ul> 131<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 132<ul class="blockList"> 133<li class="blockList"><a name="annotation.type.optional.element.summary"> 134<!-- --> 135</a> 136<h3>Optional Element Summary</h3> 137<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 138<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 139<tr> 140<th class="colFirst" scope="col">Modifier and Type</th> 141<th class="colLast" scope="col">Optional Element and Description</th> 142</tr> 143<tr class="altColor"> 144<td class="colFirst"><code><a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a></code></td> 145<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#include--">include</a></span></code> 146<div class="block">When to include attribute-property.</div> 147</td> 148</tr> 149<tr class="rowColor"> 150<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> 151<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#propName--">propName</a></span></code> 152<div class="block">Name to use for serializing value of the attribute; if not defined, 153 <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#value--"><code>value()</code></a> will be used instead.</div> 154</td> 155</tr> 156<tr class="altColor"> 157<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> 158<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#propNamespace--">propNamespace</a></span></code> 159<div class="block">Optional namespace to use; only relevant for data formats that use 160 namespaces (like XML).</div> 161</td> 162</tr> 163<tr class="rowColor"> 164<td class="colFirst"><code>boolean</code></td> 165<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#required--">required</a></span></code> 166<div class="block">Metadata about property, similar to 167 <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/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> 168</td> 169</tr> 170</table> 171</li> 172</ul> 173</li> 174</ul> 175</div> 176<div class="details"> 177<ul class="blockList"> 178<li class="blockList"> 179<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 180<ul class="blockList"> 181<li class="blockList"><a name="annotation.type.element.detail"> 182<!-- --> 183</a> 184<h3>Element Detail</h3> 185<a name="value--"> 186<!-- --> 187</a> 188<ul class="blockListLast"> 189<li class="blockList"> 190<h4>value</h4> 191<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> value</pre> 192<div class="block">Name of attribute of which value to serialize. Is also used as the 193 name of external property to write, unless overridden by 194 assigning a value for <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#propName--"><code>propName()</code></a>.</div> 195</li> 196</ul> 197</li> 198</ul> 199<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 200<ul class="blockList"> 201<li class="blockList"><a name="propName--"> 202<!-- --> 203</a> 204<ul class="blockList"> 205<li class="blockList"> 206<h4>propName</h4> 207<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> propName</pre> 208<div class="block">Name to use for serializing value of the attribute; if not defined, 209 <a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html#value--"><code>value()</code></a> will be used instead.</div> 210<dl> 211<dt>Default:</dt> 212<dd>""</dd> 213</dl> 214</li> 215</ul> 216</li> 217</ul> 218<ul class="blockList"> 219<li class="blockList"><a name="propNamespace--"> 220<!-- --> 221</a> 222<ul class="blockList"> 223<li class="blockList"> 224<h4>propNamespace</h4> 225<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> propNamespace</pre> 226<div class="block">Optional namespace to use; only relevant for data formats that use 227 namespaces (like XML).</div> 228<dl> 229<dt>Default:</dt> 230<dd>""</dd> 231</dl> 232</li> 233</ul> 234</li> 235</ul> 236<ul class="blockList"> 237<li class="blockList"><a name="include--"> 238<!-- --> 239</a> 240<ul class="blockList"> 241<li class="blockList"> 242<h4>include</h4> 243<pre>public abstract <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/com/fasterxml/jackson/annotation/JsonInclude.Include.html?is-external=true" title="class or interface in com.fasterxml.jackson.annotation">JsonInclude.Include</a> include</pre> 244<div class="block">When to include attribute-property. Default value indicates that 245 property should only be written if specified attribute has a non-null 246 value.</div> 247<dl> 248<dt>Default:</dt> 249<dd>com.fasterxml.jackson.annotation.JsonInclude.Include.NON_NULL</dd> 250</dl> 251</li> 252</ul> 253</li> 254</ul> 255<ul class="blockList"> 256<li class="blockList"><a name="required--"> 257<!-- --> 258</a> 259<ul class="blockListLast"> 260<li class="blockList"> 261<h4>required</h4> 262<pre>public abstract boolean required</pre> 263<div class="block">Metadata about property, similar to 264 <a href="http://fasterxml.github.io/jackson-annotations/javadoc/2.11/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> 265<dl> 266<dt>Default:</dt> 267<dd>false</dd> 268</dl> 269</li> 270</ul> 271</li> 272</ul> 273</li> 274</ul> 275</div> 276</div> 277<!-- ========= END OF CLASS DATA ========= --> 278<!-- ======= START OF BOTTOM NAVBAR ====== --> 279<div class="bottomNav"><a name="navbar.bottom"> 280<!-- --> 281</a> 282<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> 283<a name="navbar.bottom.firstrow"> 284<!-- --> 285</a> 286<ul class="navList" title="Navigation"> 287<li><a href="../../../../../overview-summary.html">Overview</a></li> 288<li><a href="package-summary.html">Package</a></li> 289<li class="navBarCell1Rev">Class</li> 290<li><a href="class-use/JsonAppend.Attr.html">Use</a></li> 291<li><a href="package-tree.html">Tree</a></li> 292<li><a href="../../../../../deprecated-list.html">Deprecated</a></li> 293<li><a href="../../../../../index-all.html">Index</a></li> 294<li><a href="../../../../../help-doc.html">Help</a></li> 295</ul> 296</div> 297<div class="subNav"> 298<ul class="navList"> 299<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Prev Class</span></a></li> 300<li><a href="../../../../../com/fasterxml/jackson/databind/annotation/JsonAppend.Prop.html" title="annotation in com.fasterxml.jackson.databind.annotation"><span class="typeNameLink">Next Class</span></a></li> 301</ul> 302<ul class="navList"> 303<li><a href="../../../../../index.html?com/fasterxml/jackson/databind/annotation/JsonAppend.Attr.html" target="_top">Frames</a></li> 304<li><a href="JsonAppend.Attr.html" target="_top">No Frames</a></li> 305</ul> 306<ul class="navList" id="allclasses_navbar_bottom"> 307<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> 308</ul> 309<div> 310<script type="text/javascript"><!-- 311 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 312 if(window==top) { 313 allClassesLink.style.display = "block"; 314 } 315 else { 316 allClassesLink.style.display = "none"; 317 } 318 //--> 319</script> 320</div> 321<div> 322<ul class="subNavList"> 323<li>Summary: </li> 324<li>Field | </li> 325<li><a href="#annotation.type.required.element.summary">Required</a> | </li> 326<li><a href="#annotation.type.optional.element.summary">Optional</a></li> 327</ul> 328<ul class="subNavList"> 329<li>Detail: </li> 330<li>Field | </li> 331<li><a href="#annotation.type.element.detail">Element</a></li> 332</ul> 333</div> 334<a name="skip.navbar.bottom"> 335<!-- --> 336</a></div> 337<!-- ======== END OF BOTTOM NAVBAR ======= --> 338<p class="legalCopy"><small>Copyright © 2008–2020 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 339</body> 340</html> 341