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