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 Thu Jul 07 10:49:27 PDT 2016 --> 6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<title>JsonBackReference (Jackson-annotations 2.8.0 API)</title> 8<meta name="date" content="2016-07-07"> 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="JsonBackReference (Jackson-annotations 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="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/JsonBackReference.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../../index-all.html">Index</a></li> 34<li><a href="../../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonBackReference.html" target="_top">Frames</a></li> 44<li><a href="JsonBackReference.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Required | </li> 65<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 66</ul> 67<ul class="subNavList"> 68<li>Detail: </li> 69<li><a href="#annotation_type_element_detail">Element</a></li> 70</ul> 71</div> 72<a name="skip-navbar_top"> 73<!-- --> 74</a></div> 75<!-- ========= END OF TOP NAVBAR ========= --> 76<!-- ======== START OF CLASS DATA ======== --> 77<div class="header"> 78<div class="subTitle">com.fasterxml.jackson.annotation</div> 79<h2 title="Annotation Type JsonBackReference" class="title">Annotation Type JsonBackReference</h2> 80</div> 81<div class="contentContainer"> 82<div class="description"> 83<ul class="blockList"> 84<li class="blockList"> 85<hr> 86<br> 87<pre><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>={<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#ANNOTATION_TYPE" title="class or interface in java.lang.annotation">ANNOTATION_TYPE</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</a>,<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</a>}) 88<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</a>=<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</a>) 89public @interface <span class="strong">JsonBackReference</span></pre> 90<div class="block">Annotation used to indicate that associated property is part of 91 two-way linkage between fields; and that its role is "child" (or "back") link. 92 Value type of the property must be a bean: it can not be a Collection, Map, 93 Array or enumeration. 94 Linkage is handled such that the property 95 annotated with this annotation is not serialized; and during deserialization, 96 its value is set to instance that has the "managed" (forward) link. 97<p> 98 All references have logical name to allow handling multiple linkages; typical case 99 would be that where nodes have both parent/child and sibling linkages. If so, 100 pairs of references should be named differently. 101 It is an error for a class to have multiple back references with same name, 102 even if types pointed are different. 103<p> 104 Note: only methods and fields can be annotated with this annotation: constructor 105 arguments should NOT be annotated, as they can not be either managed or back 106 references.</div> 107</li> 108</ul> 109</div> 110<div class="summary"> 111<ul class="blockList"> 112<li class="blockList"> 113<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 114<ul class="blockList"> 115<li class="blockList"><a name="annotation_type_optional_element_summary"> 116<!-- --> 117</a> 118<h3>Optional Element Summary</h3> 119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Optional Element Summary table, listing optional elements, and an explanation"> 120<caption><span>Optional Elements</span><span class="tabEnd"> </span></caption> 121<tr> 122<th class="colFirst" scope="col">Modifier and Type</th> 123<th class="colLast" scope="col">Optional Element and Description</th> 124</tr> 125<tr class="altColor"> 126<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> 127<td class="colLast"><code><strong><a href="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html#value()">value</a></strong></code> 128<div class="block">Logical have for the reference property pair; used to link managed and 129 back references.</div> 130</td> 131</tr> 132</table> 133</li> 134</ul> 135</li> 136</ul> 137</div> 138<div class="details"> 139<ul class="blockList"> 140<li class="blockList"> 141<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== --> 142<ul class="blockList"> 143<li class="blockList"><a name="annotation_type_element_detail"> 144<!-- --> 145</a> 146<h3>Element Detail</h3> 147<a name="value()"> 148<!-- --> 149</a> 150<ul class="blockListLast"> 151<li class="blockList"> 152<h4>value</h4> 153<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> 154<div class="block">Logical have for the reference property pair; used to link managed and 155 back references. Default name can be used if there is just single 156 reference pair (for example, node class that just has parent/child linkage, 157 consisting of one managed reference and matching back reference)</div> 158<dl> 159<dt>Default:</dt> 160<dd>"defaultReference"</dd> 161</dl> 162</li> 163</ul> 164</li> 165</ul> 166</li> 167</ul> 168</div> 169</div> 170<!-- ========= END OF CLASS DATA ========= --> 171<!-- ======= START OF BOTTOM NAVBAR ====== --> 172<div class="bottomNav"><a name="navbar_bottom"> 173<!-- --> 174</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 175<!-- --> 176</a> 177<ul class="navList" title="Navigation"> 178<li><a href="../../../../com/fasterxml/jackson/annotation/package-summary.html">Package</a></li> 179<li class="navBarCell1Rev">Class</li> 180<li><a href="class-use/JsonBackReference.html">Use</a></li> 181<li><a href="package-tree.html">Tree</a></li> 182<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 183<li><a href="../../../../index-all.html">Index</a></li> 184<li><a href="../../../../help-doc.html">Help</a></li> 185</ul> 186</div> 187<div class="subNav"> 188<ul class="navList"> 189<li><a href="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><span class="strong">Prev Class</span></a></li> 190<li><a href="../../../../com/fasterxml/jackson/annotation/JsonClassDescription.html" title="annotation in com.fasterxml.jackson.annotation"><span class="strong">Next Class</span></a></li> 191</ul> 192<ul class="navList"> 193<li><a href="../../../../index.html?com/fasterxml/jackson/annotation/JsonBackReference.html" target="_top">Frames</a></li> 194<li><a href="JsonBackReference.html" target="_top">No Frames</a></li> 195</ul> 196<ul class="navList" id="allclasses_navbar_bottom"> 197<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 198</ul> 199<div> 200<script type="text/javascript"><!-- 201 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 202 if(window==top) { 203 allClassesLink.style.display = "block"; 204 } 205 else { 206 allClassesLink.style.display = "none"; 207 } 208 //--> 209</script> 210</div> 211<div> 212<ul class="subNavList"> 213<li>Summary: </li> 214<li>Required | </li> 215<li><a href="#annotation_type_optional_element_summary">Optional</a></li> 216</ul> 217<ul class="subNavList"> 218<li>Detail: </li> 219<li><a href="#annotation_type_element_detail">Element</a></li> 220</ul> 221</div> 222<a name="skip-navbar_bottom"> 223<!-- --> 224</a></div> 225<!-- ======== END OF BOTTOM NAVBAR ======= --> 226<p class="legalCopy"><small>Copyright © 2008–2016 <a href="http://fasterxml.com/">FasterXML</a>. All rights reserved.</small></p> 227</body> 228</html> 229