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> 8JsonBackReference (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="JsonBackReference (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/JsonBackReference.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/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonCreator.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/JsonBackReference.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonBackReference.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 JsonBackReference</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>JsonBackReference</B></DL> 108</PRE> 109 110<P> 111Annotation used to indicate that associated property is part of 112 two-way linkage between fields; and that its role is "child" (or "back") link. 113 Value type of the property must be a bean: it can not be a Collection, Map, 114 Array or enumeration. 115 Linkage is handled such that the property 116 annotated with this annotation is not serialized; and during deserialization, 117 its value is set to instance that has the "managed" (forward) link. 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 to have multiple back 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<HR> 132 133<P> 134<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 135 136<A NAME="annotation_type_optional_element_summary"><!-- --></A> 137<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 138<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 139<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 140<B>Optional Element Summary</B></FONT></TH> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 144<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> 145<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html#value()">value</A></B></CODE> 146 147<BR> 148 Logical have for the reference property pair; used to link managed and 149 back references.</TD> 150</TR> 151</TABLE> 152 153<P> 154<A NAME="value()"><!-- --></A><H3> 155value</H3> 156<PRE> 157public 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> 158<DL> 159<DD>Logical have for the reference property pair; used to link managed and 160 back references. Default name can be used if there is just single 161 reference pair (for example, node class that just has parent/child linkage, 162 consisting of one managed reference and matching back reference) 163<P> 164<DD><DL> 165</DL> 166</DD> 167<DD><DL> 168</DL> 169<DL> 170<DT><B>Default:</B><DD>"defaultReference"</DD> 171</DL> 172</DL> 173<!-- ========= END OF CLASS DATA ========= --> 174<HR> 175 176 177<!-- ======= START OF BOTTOM NAVBAR ====== --> 178<A NAME="navbar_bottom"><!-- --></A> 179<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 180<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 181<TR><td rowspan='3'><script type="text/javascript"><!-- 182google_ad_client = "pub-1467773697956887"; 183/* Jackson-ad-small */ 184google_ad_slot = "6699487946"; 185google_ad_width = 234; 186google_ad_height = 60; 187//--> 188</script> 189<script type="text/javascript" 190src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 191</script> 192<!-- GA --> 193<script type="text/javascript"> 194var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 195document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 196</script> 197<script type="text/javascript"> 198try { 199var pageTracker = _gat._getTracker("UA-140287-6"); 200pageTracker._trackPageview(); 201} catch(err) {} 202</script> 203</td> 204<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 205<A NAME="navbar_bottom_firstrow"><!-- --></A> 206<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 207 <TR ALIGN="center" VALIGN="top"> 208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 209 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonBackReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 213 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 214 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 215 </TR> 216</TABLE> 217</TD> 218<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 219</EM> 220</TD> 221</TR> 222 223<TR> 224<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 225 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 226 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 227<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 228 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonBackReference.html" target="_top"><B>FRAMES</B></A> 229 <A HREF="JsonBackReference.html" target="_top"><B>NO FRAMES</B></A> 230 <SCRIPT type="text/javascript"> 231 <!-- 232 if(window==top) { 233 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 234 } 235 //--> 236</SCRIPT> 237<NOSCRIPT> 238 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 239</NOSCRIPT> 240 241 242</FONT></TD> 243</TR> 244<TR> 245<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 246 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 247<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 248DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 249</TR> 250</TABLE> 251<A NAME="skip-navbar_bottom"></A> 252<!-- ======== END OF BOTTOM NAVBAR ======= --> 253 254<HR> 255Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 256</BODY> 257</HTML> 258