/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/core/ReferencingMarshallingContext.html
HTML | 330 lines | 276 code | 34 blank | 20 comment | 0 complexity | 2aa5262ea0445ffd865360a30faae46e MD5 | raw file
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_26) on Thu Aug 11 04:40:24 CEST 2011 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8ReferencingMarshallingContext (XStream Core 1.4.1 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2011-08-11"> 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="ReferencingMarshallingContext (XStream Core 1.4.1 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="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReferencingMarshallingContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 <A HREF="../../../../com/thoughtworks/xstream/core/ReferenceByXPathUnmarshaller.html" title="class in com.thoughtworks.xstream.core"><B>PREV CLASS</B></A> 60 <A HREF="../../../../com/thoughtworks/xstream/core/SequenceGenerator.html" title="class in com.thoughtworks.xstream.core"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?com/thoughtworks/xstream/core/ReferencingMarshallingContext.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="ReferencingMarshallingContext.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.thoughtworks.xstream.core</FONT> 93<BR> 94Interface ReferencingMarshallingContext</H2> 95<DL> 96<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../../com/thoughtworks/xstream/converters/DataHolder.html" title="interface in com.thoughtworks.xstream.converters">DataHolder</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters">MarshallingContext</A></DD> 97</DL> 98<HR> 99<DL> 100<DT><PRE>public interface <B>ReferencingMarshallingContext</B><DT>extends <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters">MarshallingContext</A></DL> 101</PRE> 102 103<P> 104A <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters"><CODE>MarshallingContext</CODE></A> that manages references. 105<P> 106 107<P> 108<DL> 109<DT><B>Since:</B></DT> 110 <DD>1.4</DD> 111<DT><B>Author:</B></DT> 112 <DD>Jörg Schaible</DD> 113</DL> 114<HR> 115 116<P> 117 118<!-- ========== METHOD SUMMARY =========== --> 119 120<A NAME="method_summary"><!-- --></A> 121<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 122<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 123<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 124<B>Method Summary</B></FONT></TH> 125</TR> 126<TR BGCOLOR="white" CLASS="TableRowColor"> 127<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 128<CODE> <A HREF="../../../../com/thoughtworks/xstream/io/path/Path.html" title="class in com.thoughtworks.xstream.io.path">Path</A></CODE></FONT></TD> 129<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/core/ReferencingMarshallingContext.html#currentPath()">currentPath</A></B>()</CODE> 130 131<BR> 132 Retrieve the current path.</TD> 133</TR> 134<TR BGCOLOR="white" CLASS="TableRowColor"> 135<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 136<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></FONT></TD> 137<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/core/ReferencingMarshallingContext.html#lookupReference(java.lang.Object)">lookupReference</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> item)</CODE> 138 139<BR> 140 Request the reference key for the given item</TD> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 144<CODE> void</CODE></FONT></TD> 145<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/core/ReferencingMarshallingContext.html#registerImplicit(java.lang.Object)">registerImplicit</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> item)</CODE> 146 147<BR> 148 Register an implicit element.</TD> 149</TR> 150<TR BGCOLOR="white" CLASS="TableRowColor"> 151<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 152<CODE> void</CODE></FONT></TD> 153<TD><CODE><B><A HREF="../../../../com/thoughtworks/xstream/core/ReferencingMarshallingContext.html#replace(java.lang.Object, java.lang.Object)">replace</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> original, 154 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> replacement)</CODE> 155 156<BR> 157 Replace the currently marshalled item.</TD> 158</TR> 159</TABLE> 160 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.converters.MarshallingContext"><!-- --></A> 161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 162<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 163<TH ALIGN="left"><B>Methods inherited from interface com.thoughtworks.xstream.converters.<A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html" title="interface in com.thoughtworks.xstream.converters">MarshallingContext</A></B></TH> 164</TR> 165<TR BGCOLOR="white" CLASS="TableRowColor"> 166<TD><CODE><A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html#convertAnother(java.lang.Object)">convertAnother</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/MarshallingContext.html#convertAnother(java.lang.Object, com.thoughtworks.xstream.converters.Converter)">convertAnother</A></CODE></TD> 167</TR> 168</TABLE> 169 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.converters.DataHolder"><!-- --></A> 170<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 171<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 172<TH ALIGN="left"><B>Methods inherited from interface com.thoughtworks.xstream.converters.<A HREF="../../../../com/thoughtworks/xstream/converters/DataHolder.html" title="interface in com.thoughtworks.xstream.converters">DataHolder</A></B></TH> 173</TR> 174<TR BGCOLOR="white" CLASS="TableRowColor"> 175<TD><CODE><A HREF="../../../../com/thoughtworks/xstream/converters/DataHolder.html#get(java.lang.Object)">get</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/DataHolder.html#keys()">keys</A>, <A HREF="../../../../com/thoughtworks/xstream/converters/DataHolder.html#put(java.lang.Object, java.lang.Object)">put</A></CODE></TD> 176</TR> 177</TABLE> 178 179<P> 180 181<!-- ============ METHOD DETAIL ========== --> 182 183<A NAME="method_detail"><!-- --></A> 184<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 185<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 186<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 187<B>Method Detail</B></FONT></TH> 188</TR> 189</TABLE> 190 191<A NAME="currentPath()"><!-- --></A><H3> 192currentPath</H3> 193<PRE> 194<A HREF="../../../../com/thoughtworks/xstream/io/path/Path.html" title="class in com.thoughtworks.xstream.io.path">Path</A> <B>currentPath</B>()</PRE> 195<DL> 196<DD>Retrieve the current path. 197<P> 198<DD><DL> 199</DL> 200</DD> 201<DD><DL> 202 203<DT><B>Returns:</B><DD>the current path<DT><B>Since:</B></DT> 204 <DD>1.4</DD> 205</DL> 206</DD> 207</DL> 208<HR> 209 210<A NAME="lookupReference(java.lang.Object)"><!-- --></A><H3> 211lookupReference</H3> 212<PRE> 213<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> <B>lookupReference</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> item)</PRE> 214<DL> 215<DD>Request the reference key for the given item 216<P> 217<DD><DL> 218</DL> 219</DD> 220<DD><DL> 221<DT><B>Parameters:</B><DD><CODE>item</CODE> - the item to lookup 222<DT><B>Returns:</B><DD>the reference key or <code>null</code><DT><B>Since:</B></DT> 223 <DD>1.4</DD> 224</DL> 225</DD> 226</DL> 227<HR> 228 229<A NAME="replace(java.lang.Object, java.lang.Object)"><!-- --></A><H3> 230replace</H3> 231<PRE> 232void <B>replace</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> original, 233 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> replacement)</PRE> 234<DL> 235<DD>Replace the currently marshalled item. 236 237 <p><strong>Use this method only, if you know exactly what you do!</strong> It is a special solution for 238 Serializable types that make usage of the writeReplace method where the replacing object itself is referenced.</p> 239<P> 240<DD><DL> 241</DL> 242</DD> 243<DD><DL> 244<DT><B>Parameters:</B><DD><CODE>original</CODE> - the original item to convert<DD><CODE>replacement</CODE> - the replacement item that is converted instead<DT><B>Since:</B></DT> 245 <DD>1.4</DD> 246</DL> 247</DD> 248</DL> 249<HR> 250 251<A NAME="registerImplicit(java.lang.Object)"><!-- --></A><H3> 252registerImplicit</H3> 253<PRE> 254void <B>registerImplicit</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> item)</PRE> 255<DL> 256<DD>Register an implicit element. This is typically some kind of collection. 257<P> 258<DD><DL> 259</DL> 260</DD> 261<DD><DL> 262<DT><B>Parameters:</B><DD><CODE>item</CODE> - the object that is implicit<DT><B>Since:</B></DT> 263 <DD>1.4</DD> 264</DL> 265</DD> 266</DL> 267<!-- ========= END OF CLASS DATA ========= --> 268<HR> 269 270 271<!-- ======= START OF BOTTOM NAVBAR ====== --> 272<A NAME="navbar_bottom"><!-- --></A> 273<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 274<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 275<TR> 276<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 277<A NAME="navbar_bottom_firstrow"><!-- --></A> 278<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 279 <TR ALIGN="center" VALIGN="top"> 280 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 281 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 282 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 283 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ReferencingMarshallingContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 284 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 285 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 286 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 287 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 288 </TR> 289</TABLE> 290</TD> 291<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 292</EM> 293</TD> 294</TR> 295 296<TR> 297<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 298 <A HREF="../../../../com/thoughtworks/xstream/core/ReferenceByXPathUnmarshaller.html" title="class in com.thoughtworks.xstream.core"><B>PREV CLASS</B></A> 299 <A HREF="../../../../com/thoughtworks/xstream/core/SequenceGenerator.html" title="class in com.thoughtworks.xstream.core"><B>NEXT CLASS</B></A></FONT></TD> 300<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 301 <A HREF="../../../../index.html?com/thoughtworks/xstream/core/ReferencingMarshallingContext.html" target="_top"><B>FRAMES</B></A> 302 <A HREF="ReferencingMarshallingContext.html" target="_top"><B>NO FRAMES</B></A> 303 <SCRIPT type="text/javascript"> 304 <!-- 305 if(window==top) { 306 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 307 } 308 //--> 309</SCRIPT> 310<NOSCRIPT> 311 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 312</NOSCRIPT> 313 314 315</FONT></TD> 316</TR> 317<TR> 318<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 319 SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> 320<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 321DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> 322</TR> 323</TABLE> 324<A NAME="skip-navbar_bottom"></A> 325<!-- ======== END OF BOTTOM NAVBAR ======= --> 326 327<HR> 328Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 329</BODY> 330</HTML>