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> 8JsonIdentityReference (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="JsonIdentityReference (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/JsonIdentityReference.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/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 68 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.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/JsonIdentityReference.html" target="_top"><B>FRAMES</B></A> 71 <A HREF="JsonIdentityReference.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 JsonIdentityReference</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#TYPE" title="class or interface in java.lang.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>,<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/annotation/ElementType.html?is-external=true#PARAMETER" title="class or interface in java.lang.annotation">PARAMETER</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>JsonIdentityReference</B></DL> 108</PRE> 109 110<P> 111Optional annotation that can be used for customizing details of a reference 112 to Objects for which "Object Identity" is enabled (see <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><CODE>JsonIdentityInfo</CODE></A>). 113 The main use case is that of enforcing use of Object Id even for the first 114 time an Object is referenced, instead of first instance being serialized 115 as full POJO. 116<P> 117 118<P> 119<DL> 120<DT><B>Since:</B></DT> 121 <DD>2.1</DD> 122</DL> 123<HR> 124 125<P> 126<!-- =========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY =========== --> 127 128<A NAME="annotation_type_optional_element_summary"><!-- --></A> 129<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 130<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 131<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 132<B>Optional Element Summary</B></FONT></TH> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 136<CODE> boolean</CODE></FONT></TD> 137<TD><CODE><B><A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityReference.html#alwaysAsId()">alwaysAsId</A></B></CODE> 138 139<BR> 140 Marker to indicate whether all referenced values are to 141 be serialized as ids (true); or by serializing the 142 first encountered reference as POJO and only then as id (false).</TD> 143</TR> 144</TABLE> 145 146<P> 147<A NAME="alwaysAsId()"><!-- --></A><H3> 148alwaysAsId</H3> 149<PRE> 150public abstract boolean <B>alwaysAsId</B></PRE> 151<DL> 152<DD>Marker to indicate whether all referenced values are to 153 be serialized as ids (true); or by serializing the 154 first encountered reference as POJO and only then as id (false). 155<p> 156 Note that if value of 'true' is used, deserialization may require 157 additional contextual information, and possibly using a custom 158 id resolver -- the default handling may not be sufficient. 159<P> 160<DD><DL> 161</DL> 162</DD> 163<DD><DL> 164<DT><B>Since:</B></DT> 165 <DD>2.1</DD> 166</DL> 167<DL> 168<DT><B>Default:</B><DD>false</DD> 169</DL> 170</DL> 171<!-- ========= END OF CLASS DATA ========= --> 172<HR> 173 174 175<!-- ======= START OF BOTTOM NAVBAR ====== --> 176<A NAME="navbar_bottom"><!-- --></A> 177<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 178<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 179<TR><td rowspan='3'><script type="text/javascript"><!-- 180google_ad_client = "pub-1467773697956887"; 181/* Jackson-ad-small */ 182google_ad_slot = "6699487946"; 183google_ad_width = 234; 184google_ad_height = 60; 185//--> 186</script> 187<script type="text/javascript" 188src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> 189</script> 190<!-- GA --> 191<script type="text/javascript"> 192var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); 193document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); 194</script> 195<script type="text/javascript"> 196try { 197var pageTracker = _gat._getTracker("UA-140287-6"); 198pageTracker._trackPageview(); 199} catch(err) {} 200</script> 201</td> 202<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 203<A NAME="navbar_bottom_firstrow"><!-- --></A> 204<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 205 <TR ALIGN="center" VALIGN="top"> 206 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../com/fasterxml/jackson/annotation/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 207 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 208 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonIdentityReference.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 209 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 210 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 211 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 212 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 213 </TR> 214</TABLE> 215</TD> 216<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 217</EM> 218</TD> 219</TR> 220 221<TR> 222<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 223 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIdentityInfo.html" title="annotation in com.fasterxml.jackson.annotation"><B>PREV CLASS</B></A> 224 <A HREF="../../../../com/fasterxml/jackson/annotation/JsonIgnore.html" title="annotation in com.fasterxml.jackson.annotation"><B>NEXT CLASS</B></A></FONT></TD> 225<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 226 <A HREF="../../../../index.html?com/fasterxml/jackson/annotation/JsonIdentityReference.html" target="_top"><B>FRAMES</B></A> 227 <A HREF="JsonIdentityReference.html" target="_top"><B>NO FRAMES</B></A> 228 <SCRIPT type="text/javascript"> 229 <!-- 230 if(window==top) { 231 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 232 } 233 //--> 234</SCRIPT> 235<NOSCRIPT> 236 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 237</NOSCRIPT> 238 239 240</FONT></TD> 241</TR> 242<TR> 243<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 244 SUMMARY: REQUIRED | <A HREF="#annotation_type_optional_element_summary">OPTIONAL</A></FONT></TD> 245<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 246DETAIL: <A HREF="#annotation_type_element_detail">ELEMENT</A></FONT></TD> 247</TR> 248</TABLE> 249<A NAME="skip-navbar_bottom"></A> 250<!-- ======== END OF BOTTOM NAVBAR ======= --> 251 252<HR> 253Copyright © 2012 <a href="http://fasterxml.com/">FasterXML</a>. All Rights Reserved. 254</BODY> 255</HTML> 256