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