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