1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_35) on Fri Oct 05 20:53:29 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonManagedReference (Jackson-annotations 2.1.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-10-05"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="JsonManagedReference (Jackson-annotations 2.1.0 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 42 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonManagedReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 48 </TR> 49</TABLE> 50</TD> 51<TD ALIGN="right" VALIGN="top" ROWSPAN=3><script type="text/javascript"><!-- 52google_ad_client = "pub-1467773697956887"; 53/* Jackson-ad-small */ 54google_ad_slot = "6699487946"; 55google_ad_width = 234; 56google_ad_height = 60; 57//--> 58</script> 59<script type="text/javascript" 60src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 61</script> 62</TD> 63</TR> 64 65<TR> 66<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 67 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 69<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 70 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonManagedReference.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonManagedReference.html" target="_top"><B>NO FRAMES</B></A> 72 <SCRIPT type="text/javascript"> 73 <!-- 74 if(window==top) { 75 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 76 } 77 //--> 78</SCRIPT> 79<NOSCRIPT> 80 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 81</NOSCRIPT> 82 83 84</FONT></TD> 85</TR> 86<TR> 87<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 88 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 89<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 90DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 91</TR> 92</TABLE> 93<A NAME="skip-navbar_top"></A> 94<!-- ========= END OF TOP NAVBAR ========= --> 95 96<HR> 97<!-- ======== START OF CLASS DATA ======== --> 98<H2> 99<FONT SIZE="-1"> 100com.fasterxml.jackson.annotation</FONT> 101<BR> 102Annotation Type JsonManagedReference</H2> 103<HR> 104<DL> 105<DT><PRE><FONT SIZE="-1"><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true" title="class or interface in java.lang.annotation">@Target</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Target.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>={<A HREF="http://download.oracle.com/javase/1.5.0/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://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#FIELD" title="class or interface in java.lang.annotation">FIELD</A>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#METHOD" title="class or interface in java.lang.annotation">METHOD</A>}) 106<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true" title="class or interface in java.lang.annotation">@Retention</A>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/Retention.html?is-external=true#value()" title="class or interface in java.lang.annotation">value</A>=<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/RetentionPolicy.html?is-external=true#RUNTIME" title="class or interface in java.lang.annotation">RUNTIME</A>) 107</FONT>public @interface <B>JsonManagedReference</B></DL> 108</PRE> 109 110<P> 111Annotation used to indicate that annotated property is part of 112 two-way linkage between fields; and that its role is "parent" (or "forward") link. 113 Value type (class) of property must have a single compatible property annotated with 114 <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 115 annotated with this annotation is handled normally (serialized normally, no 116 special handling for deserialization); it is the matching back reference 117 that requires special handling 118<p> 119 All references have logical name to allow handling multiple linkages; typical case 120 would be that where nodes have both parent/child and sibling linkages. If so, 121 pairs of references should be named differently. 122 It is an error for a class too have multiple managed references with same name, 123 even if types pointed are different. 124<p> 125 Note: only methods and fields can be annotated with this annotation: constructor 126 arguments should NOT be annotated, as they can not be either managed or back 127 references. 128<P> 129 130<P> 131<DL> 132<DT><B>Author:</B></DT> 133 <DD>tatu</DD> 134</DL> 135<HR> 136 137<P> 138<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 139 140<A NAME="annotation_type_optional_element_summary"><!-- --></A> 141<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 142<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 143<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 144<B>Optional Element Summary</B></FONT></TH> 145</TR> 146<TR BGCOLOR="white" CLASS="TableRowColor"> 147<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 148<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> 149<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonManagedReference.html#value()">value</A></B></CODE> 150 151<BR> 152 Logical have for the reference property pair; used to link managed and 153 back references.</TD> 154</TR> 155</TABLE> 156 157<P> 158<A NAME="value()"><!-- --></A><H3> 159value</H3> 160<PRE> 161public abstract <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>value</B></PRE> 162<DL> 163<DD>Logical have for the reference property pair; used to link managed and 164 back references. Default name can be used if there is just single 165 reference pair (for example, node class that just has parent/child linkage, 166 consisting of one managed reference and matching back reference) 167<P> 168<DD><DL> 169</DL> 170</DD> 171<DD><DL> 172</DL> 173<DL> 174<DT><B>Default:</B><DD>"defaultReference"</DD> 175</DL> 176</DL> 177<!-- ========= END OF CLASS DATA ========= --> 178<HR> 179 180 181<!-- ======= START OF BOTTOM NAVBAR ====== --> 182<A NAME="navbar_bottom"><!-- --></A> 183<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 184<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 185<TR><td rowspan='3'><script type="text/javascript"><!-- 186google_ad_client = "pub-1467773697956887"; 187/* Jackson-ad-small */ 188google_ad_slot = "6699487946"; 189google_ad_width = 234; 190google_ad_height = 60; 191//--> 192</script> 193<script type="text/javascript" 194src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 195</script> 196<!-- GA --> 197<script type="text/javascript"> 198var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 199document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 200</script> 201<script type="text/javascript"> 202try { 203var pageTracker = _gat._getTracker("UA-140287-6"); 204pageTracker._trackPageview(); 205} catch(err) {} 206</script> 207</td> 208<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 209<A NAME="navbar_bottom_firstrow"><!-- --></A> 210<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 211 <TR ALIGN="center" VALIGN="top"> 212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 213 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonManagedReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 215 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 216 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 217 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 218 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 219 </TR> 220</TABLE> 221</TD> 222<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 223</EM> 224</TD> 225</TR> 226 227<TR> 228<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 229 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonInclude.Include.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 230 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonProperty.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 231<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 232 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonManagedReference.html" target="_top"><B>FRAMES</B></A> 233 <A HREF="JsonManagedReference.html" target="_top"><B>NO FRAMES</B></A> 234 <SCRIPT type="text/javascript"> 235 <!-- 236 if(window==top) { 237 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 238 } 239 //--> 240</SCRIPT> 241<NOSCRIPT> 242 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 243</NOSCRIPT> 244 245 246</FONT></TD> 247</TR> 248<TR> 249<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 250 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 251<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 252DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 253</TR> 254</TABLE> 255<A NAME="skip-navbar_bottom"></A> 256<!-- ======== END OF BOTTOM NAVBAR ======= --> 257 258<HR> 259Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 260</BODY> 261</HTML> 262