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