/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/xml/TraxSource.html
HTML | 584 lines | 505 code | 55 blank | 24 comment | 0 complexity | 2068538698d7925418ecff518347f4b6 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> 8TraxSource (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="TraxSource (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/TraxSource.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/io/xml/StaxWriter.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 60 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/WstxDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/TraxSource.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="TraxSource.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <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.io.xml</FONT> 93<BR> 94Class TraxSource</H2> 95<PRE> 96<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">javax.xml.transform.sax.SAXSource</A> 98 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.xml.TraxSource</B> 99</PRE> 100<DL> 101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/Source.html?is-external=true" title="class or interface in javax.xml.transform">Source</A></DD> 102</DL> 103<HR> 104<DL> 105<DT><PRE>public class <B>TraxSource</B><DT>extends <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></DL> 106</PRE> 107 108<P> 109A <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax"><CODE>JAXP TrAX Source</CODE></A> that enables using XStream object serialization as 110 direct input for XSLT processors without resorting to an intermediate representation such as 111 text XML, DOM or DOM4J. <p/> The following example shows how to apply an XSL Transformation 112 to a set of Java objects gathered into a List (<code>source</code>): 113 </p> 114 115 <pre><code> 116 public static String transform(List source, String stylesheet) { 117 try { 118 Transformer transformer = TransformerFactory.newInstance().newTransformer( 119 new StreamSource(stylesheet)); 120 TraxSource in = new TraxSource(source); 121 Writer out = new StringWriter(); 122 transformer.transform(in, new StreamResult(out)); 123 return out.toString(); 124 } catch (TransformerException e) { 125 throw new RuntimeException("XSLT Transformation failed", e); 126 } 127 } 128 </code></pre> 129<P> 130 131<P> 132<DL> 133<DT><B>Author:</B></DT> 134 <DD>Laurent Bihanic</DD> 135</DL> 136<HR> 137 138<P> 139<!-- =========== FIELD SUMMARY =========== --> 140 141<A NAME="field_summary"><!-- --></A> 142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 145<B>Field Summary</B></FONT></TH> 146</TR> 147<TR BGCOLOR="white" CLASS="TableRowColor"> 148<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 149<CODE>static <A HREF="http://download.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> 150<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#XSTREAM_FEATURE">XSTREAM_FEATURE</A></B></CODE> 151 152<BR> 153 If <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerFactory.html?is-external=true#getFeature(java.lang.String)" title="class or interface in javax.xml.transform"><CODE>TransformerFactory.getFeature(java.lang.String)</CODE></A> returns <code>true</code> 154 when passed this value as an argument, the Transformer natively supports XStream.</TD> 155</TR> 156</TABLE> 157 <A NAME="fields_inherited_from_class_javax.xml.transform.sax.SAXSource"><!-- --></A> 158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 159<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 160<TH ALIGN="left"><B>Fields inherited from class javax.xml.transform.sax.<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></B></TH> 161</TR> 162<TR BGCOLOR="white" CLASS="TableRowColor"> 163<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#FEATURE" title="class or interface in javax.xml.transform.sax">FEATURE</A></CODE></TD> 164</TR> 165</TABLE> 166 167<!-- ======== CONSTRUCTOR SUMMARY ======== --> 168 169<A NAME="constructor_summary"><!-- --></A> 170<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 171<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 172<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 173<B>Constructor Summary</B></FONT></TH> 174</TR> 175<TR BGCOLOR="white" CLASS="TableRowColor"> 176<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#TraxSource()">TraxSource</A></B>()</CODE> 177 178<BR> 179 Creates a XStream TrAX source.</TD> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#TraxSource(java.util.List)">TraxSource</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> source)</CODE> 183 184<BR> 185 Creates a XStream TrAX source, setting the objects to marshal.</TD> 186</TR> 187<TR BGCOLOR="white" CLASS="TableRowColor"> 188<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#TraxSource(java.util.List, com.thoughtworks.xstream.XStream)">TraxSource</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> source, 189 <A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</CODE> 190 191<BR> 192 Creates a XStream TrAX source, setting the objects to marshal and a configured (with 193 aliases) XStream facade.</TD> 194</TR> 195<TR BGCOLOR="white" CLASS="TableRowColor"> 196<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#TraxSource(java.lang.Object)">TraxSource</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> source)</CODE> 197 198<BR> 199 Creates a XStream TrAX source, specifying the object to marshal.</TD> 200</TR> 201<TR BGCOLOR="white" CLASS="TableRowColor"> 202<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#TraxSource(java.lang.Object, com.thoughtworks.xstream.XStream)">TraxSource</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> source, 203 <A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</CODE> 204 205<BR> 206 Creates a XStream TrAX source, specifying the object to marshal and a configured (with 207 aliases) XStream facade.</TD> 208</TR> 209</TABLE> 210 211<!-- ========== METHOD SUMMARY =========== --> 212 213<A NAME="method_summary"><!-- --></A> 214<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 215<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 216<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 217<B>Method Summary</B></FONT></TH> 218</TR> 219<TR BGCOLOR="white" CLASS="TableRowColor"> 220<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 221<CODE> <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A></CODE></FONT></TD> 222<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#getXMLReader()">getXMLReader</A></B>()</CODE> 223 224<BR> 225 Returns the XMLReader to be used for the Source.</TD> 226</TR> 227<TR BGCOLOR="white" CLASS="TableRowColor"> 228<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 229<CODE> void</CODE></FONT></TD> 230<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setInputSource(org.xml.sax.InputSource)">setInputSource</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</A> inputSource)</CODE> 231 232<BR> 233 Sets the SAX InputSource to be used for the Source.</TD> 234</TR> 235<TR BGCOLOR="white" CLASS="TableRowColor"> 236<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 237<CODE> void</CODE></FONT></TD> 238<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSource(java.lang.Object)">setSource</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> obj)</CODE> 239 240<BR> 241 Sets the object to marshal.</TD> 242</TR> 243<TR BGCOLOR="white" CLASS="TableRowColor"> 244<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 245<CODE> void</CODE></FONT></TD> 246<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSourceAsList(java.util.List)">setSourceAsList</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> list)</CODE> 247 248<BR> 249 Sets the list of objects to marshal.</TD> 250</TR> 251<TR BGCOLOR="white" CLASS="TableRowColor"> 252<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 253<CODE> void</CODE></FONT></TD> 254<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setXMLReader(org.xml.sax.XMLReader)">setXMLReader</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> reader)</CODE> 255 256<BR> 257 Set the XMLReader to be used for the Source.</TD> 258</TR> 259<TR BGCOLOR="white" CLASS="TableRowColor"> 260<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 261<CODE> void</CODE></FONT></TD> 262<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setXStream(com.thoughtworks.xstream.XStream)">setXStream</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</CODE> 263 264<BR> 265 Sets the XStream facade to use when marshalling objects.</TD> 266</TR> 267</TABLE> 268 <A NAME="methods_inherited_from_class_javax.xml.transform.sax.SAXSource"><!-- --></A> 269<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 270<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 271<TH ALIGN="left"><B>Methods inherited from class javax.xml.transform.sax.<A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></B></TH> 272</TR> 273<TR BGCOLOR="white" CLASS="TableRowColor"> 274<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#getInputSource()" title="class or interface in javax.xml.transform.sax">getInputSource</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#getSystemId()" title="class or interface in javax.xml.transform.sax">getSystemId</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#setSystemId(java.lang.String)" title="class or interface in javax.xml.transform.sax">setSystemId</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#sourceToInputSource(javax.xml.transform.Source)" title="class or interface in javax.xml.transform.sax">sourceToInputSource</A></CODE></TD> 275</TR> 276</TABLE> 277 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 278<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 279<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 280<TH ALIGN="left"><B>Methods inherited from class java.lang.<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></TH> 281</TR> 282<TR BGCOLOR="white" CLASS="TableRowColor"> 283<TD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 284</TR> 285</TABLE> 286 287<P> 288 289<!-- ============ FIELD DETAIL =========== --> 290 291<A NAME="field_detail"><!-- --></A> 292<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 293<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 294<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 295<B>Field Detail</B></FONT></TH> 296</TR> 297</TABLE> 298 299<A NAME="XSTREAM_FEATURE"><!-- --></A><H3> 300XSTREAM_FEATURE</H3> 301<PRE> 302public static final <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>XSTREAM_FEATURE</B></PRE> 303<DL> 304<DD>If <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/TransformerFactory.html?is-external=true#getFeature(java.lang.String)" title="class or interface in javax.xml.transform"><CODE>TransformerFactory.getFeature(java.lang.String)</CODE></A> returns <code>true</code> 305 when passed this value as an argument, the Transformer natively supports XStream. <p/> 306 <strong>Note</strong>: This implementation does not override the 307 <A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#FEATURE" title="class or interface in javax.xml.transform.sax"><CODE>SAXSource.FEATURE</CODE></A> value defined by its superclass to be considered as a SAXSource 308 by Transformer implementations not natively supporting this XStream-specific source 309 </p> 310<P> 311<DL> 312<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.xml.TraxSource.XSTREAM_FEATURE">Constant Field Values</A></DL> 313</DL> 314 315<!-- ========= CONSTRUCTOR DETAIL ======== --> 316 317<A NAME="constructor_detail"><!-- --></A> 318<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 319<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 320<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 321<B>Constructor Detail</B></FONT></TH> 322</TR> 323</TABLE> 324 325<A NAME="TraxSource()"><!-- --></A><H3> 326TraxSource</H3> 327<PRE> 328public <B>TraxSource</B>()</PRE> 329<DL> 330<DD>Creates a XStream TrAX source. 331<P> 332</DL> 333<HR> 334 335<A NAME="TraxSource(java.lang.Object)"><!-- --></A><H3> 336TraxSource</H3> 337<PRE> 338public <B>TraxSource</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> source)</PRE> 339<DL> 340<DD>Creates a XStream TrAX source, specifying the object to marshal. 341<P> 342<DL> 343<DT><B>Parameters:</B><DD><CODE>source</CODE> - the object to marshal. 344<DT><B>Throws:</B> 345<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> is <code>null</code>.<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSource(java.lang.Object)"><CODE>setSource(java.lang.Object)</CODE></A></DL> 346</DL> 347<HR> 348 349<A NAME="TraxSource(java.lang.Object, com.thoughtworks.xstream.XStream)"><!-- --></A><H3> 350TraxSource</H3> 351<PRE> 352public <B>TraxSource</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> source, 353 <A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</PRE> 354<DL> 355<DD>Creates a XStream TrAX source, specifying the object to marshal and a configured (with 356 aliases) XStream facade. 357<P> 358<DL> 359<DT><B>Parameters:</B><DD><CODE>source</CODE> - the object to marshal.<DD><CODE>xstream</CODE> - a configured XStream facade. 360<DT><B>Throws:</B> 361<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> or <code>xstream</code> is 362 <code>null</code>.<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSource(java.lang.Object)"><CODE>setSource(java.lang.Object)</CODE></A>, 363<A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setXStream(com.thoughtworks.xstream.XStream)"><CODE>setXStream(com.thoughtworks.xstream.XStream)</CODE></A></DL> 364</DL> 365<HR> 366 367<A NAME="TraxSource(java.util.List)"><!-- --></A><H3> 368TraxSource</H3> 369<PRE> 370public <B>TraxSource</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> source)</PRE> 371<DL> 372<DD>Creates a XStream TrAX source, setting the objects to marshal. 373<P> 374<DL> 375<DT><B>Parameters:</B><DD><CODE>source</CODE> - the list of objects to marshal. 376<DT><B>Throws:</B> 377<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> is <code>null</code> or 378 empty.<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSourceAsList(java.util.List)"><CODE>setSourceAsList(java.util.List)</CODE></A></DL> 379</DL> 380<HR> 381 382<A NAME="TraxSource(java.util.List, com.thoughtworks.xstream.XStream)"><!-- --></A><H3> 383TraxSource</H3> 384<PRE> 385public <B>TraxSource</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> source, 386 <A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</PRE> 387<DL> 388<DD>Creates a XStream TrAX source, setting the objects to marshal and a configured (with 389 aliases) XStream facade. 390<P> 391<DL> 392<DT><B>Parameters:</B><DD><CODE>source</CODE> - the list of objects to marshal.<DD><CODE>xstream</CODE> - a configured XStream facade. 393<DT><B>Throws:</B> 394<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> or <code>xstream</code> is 395 <code>null</code> or <code>source</code> is empty.<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setSourceAsList(java.util.List)"><CODE>setSourceAsList(java.util.List)</CODE></A>, 396<A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#setXStream(com.thoughtworks.xstream.XStream)"><CODE>setXStream(com.thoughtworks.xstream.XStream)</CODE></A></DL> 397</DL> 398 399<!-- ============ METHOD DETAIL ========== --> 400 401<A NAME="method_detail"><!-- --></A> 402<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 403<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 404<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 405<B>Method Detail</B></FONT></TH> 406</TR> 407</TABLE> 408 409<A NAME="setInputSource(org.xml.sax.InputSource)"><!-- --></A><H3> 410setInputSource</H3> 411<PRE> 412public void <B>setInputSource</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/InputSource.html?is-external=true" title="class or interface in org.xml.sax">InputSource</A> inputSource)</PRE> 413<DL> 414<DD>Sets the SAX InputSource to be used for the Source. <p/> As this implementation only 415 supports object lists as data source, this method always throws an 416 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><CODE>UnsupportedOperationException</CODE></A>. 417 </p> 418<P> 419<DD><DL> 420<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#setInputSource(org.xml.sax.InputSource)" title="class or interface in javax.xml.transform.sax">setInputSource</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></CODE></DL> 421</DD> 422<DD><DL> 423<DT><B>Parameters:</B><DD><CODE>inputSource</CODE> - a valid InputSource reference. 424<DT><B>Throws:</B> 425<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - always!</DL> 426</DD> 427</DL> 428<HR> 429 430<A NAME="setXMLReader(org.xml.sax.XMLReader)"><!-- --></A><H3> 431setXMLReader</H3> 432<PRE> 433public void <B>setXMLReader</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> reader)</PRE> 434<DL> 435<DD>Set the XMLReader to be used for the Source. <p/> As this implementation only supports 436 object lists as data source, this method throws an <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><CODE>UnsupportedOperationException</CODE></A> 437 if the provided reader object does not implement the SAX <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLFilter.html?is-external=true" title="class or interface in org.xml.sax"><CODE>XMLFilter</CODE></A> interface. 438 Otherwise, a <A HREF="../../../../../com/thoughtworks/xstream/io/xml/SaxWriter.html" title="class in com.thoughtworks.xstream.io.xml"><CODE>SaxWriter</CODE></A> instance will be attached as parent of the filter chain. 439 </p> 440<P> 441<DD><DL> 442<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#setXMLReader(org.xml.sax.XMLReader)" title="class or interface in javax.xml.transform.sax">setXMLReader</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></CODE></DL> 443</DD> 444<DD><DL> 445<DT><B>Parameters:</B><DD><CODE>reader</CODE> - a valid XMLReader or XMLFilter reference. 446<DT><B>Throws:</B> 447<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - if <code>reader</code> is not a SAX 448 <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLFilter.html?is-external=true" title="class or interface in org.xml.sax"><CODE>XMLFilter</CODE></A>.<DT><B>See Also:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/xml/TraxSource.html#getXMLReader()"><CODE>getXMLReader()</CODE></A></DL> 449</DD> 450</DL> 451<HR> 452 453<A NAME="getXMLReader()"><!-- --></A><H3> 454getXMLReader</H3> 455<PRE> 456public <A HREF="http://download.oracle.com/javase/6/docs/api/org/xml/sax/XMLReader.html?is-external=true" title="class or interface in org.xml.sax">XMLReader</A> <B>getXMLReader</B>()</PRE> 457<DL> 458<DD>Returns the XMLReader to be used for the Source. <p/> This implementation returns a 459 specific XMLReader (<A HREF="../../../../../com/thoughtworks/xstream/io/xml/SaxWriter.html" title="class in com.thoughtworks.xstream.io.xml"><CODE>SaxWriter</CODE></A>) generating the XML from a list of input objects. 460 </p> 461<P> 462<DD><DL> 463<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true#getXMLReader()" title="class or interface in javax.xml.transform.sax">getXMLReader</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/6/docs/api/javax/xml/transform/sax/SAXSource.html?is-external=true" title="class or interface in javax.xml.transform.sax">SAXSource</A></CODE></DL> 464</DD> 465<DD><DL> 466 467<DT><B>Returns:</B><DD>an XMLReader generating the XML from a list of input objects.</DL> 468</DD> 469</DL> 470<HR> 471 472<A NAME="setXStream(com.thoughtworks.xstream.XStream)"><!-- --></A><H3> 473setXStream</H3> 474<PRE> 475public void <B>setXStream</B>(<A HREF="../../../../../com/thoughtworks/xstream/XStream.html" title="class in com.thoughtworks.xstream">XStream</A> xstream)</PRE> 476<DL> 477<DD>Sets the XStream facade to use when marshalling objects. 478<P> 479<DD><DL> 480<DT><B>Parameters:</B><DD><CODE>xstream</CODE> - a configured XStream facade. 481<DT><B>Throws:</B> 482<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>xstream</code> is <code>null</code>.</DL> 483</DD> 484</DL> 485<HR> 486 487<A NAME="setSource(java.lang.Object)"><!-- --></A><H3> 488setSource</H3> 489<PRE> 490public void <B>setSource</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> obj)</PRE> 491<DL> 492<DD>Sets the object to marshal. 493<P> 494<DD><DL> 495<DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to marshal. 496<DT><B>Throws:</B> 497<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> is <code>null</code>.</DL> 498</DD> 499</DL> 500<HR> 501 502<A NAME="setSourceAsList(java.util.List)"><!-- --></A><H3> 503setSourceAsList</H3> 504<PRE> 505public void <B>setSourceAsList</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</A> list)</PRE> 506<DL> 507<DD>Sets the list of objects to marshal. <p/> When dealing with non-text input (such as SAX 508 or DOM), XSLT processors support multiple root node children for the source tree (see <a 509 href="http://www.w3.org/TR/xslt#root-node-children">section 3.1</a> of the "XSL 510 Transformations (XSLT) Version 1.0" specification. Using a list of objects as source 511 makes use of this feature and allows creating XML documents merging the XML serialization 512 of several Java objects. 513<P> 514<DD><DL> 515<DT><B>Parameters:</B><DD><CODE>list</CODE> - the list of objects to marshal. 516<DT><B>Throws:</B> 517<DD><CODE><A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</A></CODE> - if <code>source</code> is <code>null</code> or 518 empty.</DL> 519</DD> 520</DL> 521<!-- ========= END OF CLASS DATA ========= --> 522<HR> 523 524 525<!-- ======= START OF BOTTOM NAVBAR ====== --> 526<A NAME="navbar_bottom"><!-- --></A> 527<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 528<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 529<TR> 530<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 531<A NAME="navbar_bottom_firstrow"><!-- --></A> 532<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 533 <TR ALIGN="center" VALIGN="top"> 534 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 535 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 536 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 537 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/TraxSource.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 538 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 539 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 540 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 541 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 542 </TR> 543</TABLE> 544</TD> 545<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 546</EM> 547</TD> 548</TR> 549 550<TR> 551<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 552 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/StaxWriter.html" title="class in com.thoughtworks.xstream.io.xml"><B>PREV CLASS</B></A> 553 <A HREF="../../../../../com/thoughtworks/xstream/io/xml/WstxDriver.html" title="class in com.thoughtworks.xstream.io.xml"><B>NEXT CLASS</B></A></FONT></TD> 554<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 555 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/xml/TraxSource.html" target="_top"><B>FRAMES</B></A> 556 <A HREF="TraxSource.html" target="_top"><B>NO FRAMES</B></A> 557 <SCRIPT type="text/javascript"> 558 <!-- 559 if(window==top) { 560 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 561 } 562 //--> 563</SCRIPT> 564<NOSCRIPT> 565 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 566</NOSCRIPT> 567 568 569</FONT></TD> 570</TR> 571<TR> 572<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 573 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 574<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 575DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 576</TR> 577</TABLE> 578<A NAME="skip-navbar_bottom"></A> 579<!-- ======== END OF BOTTOM NAVBAR ======= --> 580 581<HR> 582Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 583</BODY> 584</HTML>