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_29) on Mon Mar 26 18:49:10 PDT 2012 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JsonBackReference (Jackson-annotations 2.0.0 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2012-03-26"> 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.0.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><EM> 52</EM> 53</TD> 54</TR> 55 56<TR> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 59 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 61 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonBackReference.html" target="_top"><B>FRAMES</B></A> 62 <A HREF="JsonBackReference.html" target="_top"><B>NO FRAMES</B></A> 63 <SCRIPT type="text/javascript"> 64 <!-- 65 if(window==top) { 66 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 67 } 68 //--> 69</SCRIPT> 70<NOSCRIPT> 71 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 72</NOSCRIPT> 73 74 75</FONT></TD> 76</TR> 77<TR> 78<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 79 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 81DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 82</TR> 83</TABLE> 84<A NAME="skip-navbar_top"></A> 85<!-- ========= END OF TOP NAVBAR ========= --> 86 87<HR> 88<!-- ======== START OF CLASS DATA ======== --> 89<H2> 90<FONT SIZE="-1"> 91com.fasterxml.jackson.annotation</FONT> 92<BR> 93Annotation Type JsonBackReference</H2> 94<HR> 95<DL> 96<DT><PRE><FONT SIZE="-1"><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>}) 97<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>) 98</FONT>public @interface <B>JsonBackReference</B></DL> 99</PRE> 100 101<P> 102Annotation used to indicate that associated property is part of 103 two-way linkage between fields; and that its role is "child" (or "back") link. 104 Value type of the property must be a bean: it can not be a Collection, Map, 105 Array or enumeration. 106 Linkage is handled such that the property 107 annotated with this annotation is not serialized; and during deserialization, 108 its value is set to instance that has the "managed" (forward) link. 109<p> 110 All references have logical name to allow handling multiple linkages; typical case 111 would be that where nodes have both parent/child and sibling linkages. If so, 112 pairs of references should be named differently. 113 It is an error for a class to have multiple back references with same name, 114 even if types pointed are different. 115<p> 116 Note: only methods and fields can be annotated with this annotation: constructor 117 arguments should NOT be annotated, as they can not be either managed or back 118 references. 119<P> 120 121<P> 122<HR> 123 124<P> 125<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 126 127<A NAME="annotation_type_optional_element_summary"><!-- --></A> 128<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 129<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 130<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 131<B>Optional Element Summary</B></FONT></TH> 132</TR> 133<TR BGCOLOR="white" CLASS="TableRowColor"> 134<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 135<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></FONT></TD> 136<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonBackReference.html#value()">value</A></B></CODE> 137 138<BR> 139 Logical have for the reference property pair; used to link managed and 140 back references.</TD> 141</TR> 142</TABLE> 143 144<P> 145<A NAME="value()"><!-- --></A><H3> 146value</H3> 147<PRE> 148public 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> <B>value</B></PRE> 149<DL> 150<DD>Logical have for the reference property pair; used to link managed and 151 back references. Default name can be used if there is just single 152 reference pair (for example, node class that just has parent/child linkage, 153 consisting of one managed reference and matching back reference) 154<P> 155<DD><DL> 156</DL> 157</DD> 158<DD><DL> 159</DL> 160<DL> 161<DT><B>Default:</B><DD>"defaultReference"</DD> 162</DL> 163</DL> 164<!-- ========= END OF CLASS DATA ========= --> 165<HR> 166 167 168<!-- ======= START OF BOTTOM NAVBAR ====== --> 169<A NAME="navbar_bottom"><!-- --></A> 170<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 171<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 172<TR> 173<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 174<A NAME="navbar_bottom_firstrow"><!-- --></A> 175<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 176 <TR ALIGN="center" VALIGN="top"> 177 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 178 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 179 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonBackReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 180 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 181 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 182 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 183 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 184 </TR> 185</TABLE> 186</TD> 187<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 188</EM> 189</TD> 190</TR> 191 192<TR> 193<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 194 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonAutoDetect.Visibility.html" title="enum in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 195 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonCreator.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 196<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 197 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonBackReference.html" target="_top"><B>FRAMES</B></A> 198 <A HREF="JsonBackReference.html" target="_top"><B>NO FRAMES</B></A> 199 <SCRIPT type="text/javascript"> 200 <!-- 201 if(window==top) { 202 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 203 } 204 //--> 205</SCRIPT> 206<NOSCRIPT> 207 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 208</NOSCRIPT> 209 210 211</FONT></TD> 212</TR> 213<TR> 214<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 215 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 216<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 217DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 218</TR> 219</TABLE> 220<A NAME="skip-navbar_bottom"></A> 221<!-- ======== END OF BOTTOM NAVBAR ======= --> 222 223<HR> 224Copyright © 2012 <a href="http://fasterxml.com">fasterxml.com</a>. All Rights Reserved. 225</BODY> 226</HTML> 227