/lib/docs/org/apache/xmlrpc/jaxb/JaxbSerializer.html
HTML | 348 lines | 286 code | 38 blank | 24 comment | 0 complexity | 8dbe73420e1d13d517e31f0220e78f03 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_0) on Mon Apr 20 21:45:58 CEST 2009 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8JaxbSerializer (Apache XML-RPC 3.1.2 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2009-04-20"> 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="JaxbSerializer (Apache XML-RPC 3.1.2 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/JaxbSerializer.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="../../../../org/apache/xmlrpc/jaxb/JaxbParser.html" title="class in org.apache.xmlrpc.jaxb"><B>PREV CLASS</B></A> 60 <A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbTypeFactory.html" title="class in org.apache.xmlrpc.jaxb"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../index.html?org/apache/xmlrpc/jaxb/JaxbSerializer.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="JaxbSerializer.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"> 92org.apache.xmlrpc.jaxb</FONT> 93<BR> 94Class JaxbSerializer</H2> 95<PRE> 96java.lang.Object 97 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html" title="class in org.apache.xmlrpc.serializer">org.apache.xmlrpc.serializer.ExtSerializer</A> 98 <IMG SRC="../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.xmlrpc.jaxb.JaxbSerializer</B> 99</PRE> 100<DL> 101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../org/apache/xmlrpc/serializer/TypeSerializer.html" title="interface in org.apache.xmlrpc.serializer">TypeSerializer</A></DD> 102</DL> 103<HR> 104<DL> 105<DT><PRE>public class <B>JaxbSerializer</B><DT>extends <A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html" title="class in org.apache.xmlrpc.serializer">ExtSerializer</A></DL> 106</PRE> 107 108<P> 109A serializer for JAXB objects. 110<P> 111 112<P> 113<HR> 114 115<P> 116<!-- =========== FIELD SUMMARY =========== --> 117 118<A NAME="field_summary"><!-- --></A> 119<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 120<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 121<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 122<B>Field Summary</B></FONT></TH> 123</TR> 124<TR BGCOLOR="white" CLASS="TableRowColor"> 125<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 126<CODE>static java.lang.String</CODE></FONT></TD> 127<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbSerializer.html#JAXB_TAG">JAXB_TAG</A></B></CODE> 128 129<BR> 130 The tag name for serializing JAXB objects.</TD> 131</TR> 132</TABLE> 133 134<!-- ======== CONSTRUCTOR SUMMARY ======== --> 135 136<A NAME="constructor_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>Constructor Summary</B></FONT></TH> 141</TR> 142<TR BGCOLOR="white" CLASS="TableRowColor"> 143<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbSerializer.html#JaxbSerializer(javax.xml.bind.JAXBContext)">JaxbSerializer</A></B>(javax.xml.bind.JAXBContext pContext)</CODE> 144 145<BR> 146 Creates a new instance with the given context.</TD> 147</TR> 148</TABLE> 149 150<!-- ========== METHOD SUMMARY =========== --> 151 152<A NAME="method_summary"><!-- --></A> 153<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 154<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 155<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 156<B>Method Summary</B></FONT></TH> 157</TR> 158<TR BGCOLOR="white" CLASS="TableRowColor"> 159<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 160<CODE>protected java.lang.String</CODE></FONT></TD> 161<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbSerializer.html#getTagName()">getTagName</A></B>()</CODE> 162 163<BR> 164 Returns the unqualied tag name.</TD> 165</TR> 166<TR BGCOLOR="white" CLASS="TableRowColor"> 167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 168<CODE>protected void</CODE></FONT></TD> 169<TD><CODE><B><A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbSerializer.html#serialize(org.xml.sax.ContentHandler, java.lang.Object)">serialize</A></B>(org.xml.sax.ContentHandler pHandler, 170 java.lang.Object pObject)</CODE> 171 172<BR> 173 Performs the actual serialization.</TD> 174</TR> 175</TABLE> 176 <A NAME="methods_inherited_from_class_org.apache.xmlrpc.serializer.ExtSerializer"><!-- --></A> 177<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 178<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 179<TH ALIGN="left"><B>Methods inherited from class org.apache.xmlrpc.serializer.<A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html" title="class in org.apache.xmlrpc.serializer">ExtSerializer</A></B></TH> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD><CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html#write(org.xml.sax.ContentHandler, java.lang.Object)">write</A></CODE></TD> 183</TR> 184</TABLE> 185 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 186<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 187<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 188<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> 189</TR> 190<TR BGCOLOR="white" CLASS="TableRowColor"> 191<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> 192</TR> 193</TABLE> 194 195<P> 196 197<!-- ============ FIELD DETAIL =========== --> 198 199<A NAME="field_detail"><!-- --></A> 200<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 201<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 202<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 203<B>Field Detail</B></FONT></TH> 204</TR> 205</TABLE> 206 207<A NAME="JAXB_TAG"><!-- --></A><H3> 208JAXB_TAG</H3> 209<PRE> 210public static final java.lang.String <B>JAXB_TAG</B></PRE> 211<DL> 212<DD>The tag name for serializing JAXB objects. 213<P> 214<DL> 215<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.xmlrpc.jaxb.JaxbSerializer.JAXB_TAG">Constant Field Values</A></DL> 216</DL> 217 218<!-- ========= CONSTRUCTOR DETAIL ======== --> 219 220<A NAME="constructor_detail"><!-- --></A> 221<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 222<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 223<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 224<B>Constructor Detail</B></FONT></TH> 225</TR> 226</TABLE> 227 228<A NAME="JaxbSerializer(javax.xml.bind.JAXBContext)"><!-- --></A><H3> 229JaxbSerializer</H3> 230<PRE> 231public <B>JaxbSerializer</B>(javax.xml.bind.JAXBContext pContext)</PRE> 232<DL> 233<DD>Creates a new instance with the given context. 234<P> 235<DL> 236<DT><B>Parameters:</B><DD><CODE>pContext</CODE> - The context being used for creating marshallers.</DL> 237</DL> 238 239<!-- ============ METHOD DETAIL ========== --> 240 241<A NAME="method_detail"><!-- --></A> 242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 243<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 244<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 245<B>Method Detail</B></FONT></TH> 246</TR> 247</TABLE> 248 249<A NAME="getTagName()"><!-- --></A><H3> 250getTagName</H3> 251<PRE> 252protected java.lang.String <B>getTagName</B>()</PRE> 253<DL> 254<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html#getTagName()">ExtSerializer</A></CODE></B></DD> 255<DD>Returns the unqualied tag name. 256<P> 257<DD><DL> 258<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html#getTagName()">getTagName</A></CODE> in class <CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html" title="class in org.apache.xmlrpc.serializer">ExtSerializer</A></CODE></DL> 259</DD> 260<DD><DL> 261</DL> 262</DD> 263</DL> 264<HR> 265 266<A NAME="serialize(org.xml.sax.ContentHandler, java.lang.Object)"><!-- --></A><H3> 267serialize</H3> 268<PRE> 269protected void <B>serialize</B>(org.xml.sax.ContentHandler pHandler, 270 java.lang.Object pObject) 271 throws org.xml.sax.SAXException</PRE> 272<DL> 273<DD><B>Description copied from class: <CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html#serialize(org.xml.sax.ContentHandler, java.lang.Object)">ExtSerializer</A></CODE></B></DD> 274<DD>Performs the actual serialization. 275<P> 276<DD><DL> 277<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html#serialize(org.xml.sax.ContentHandler, java.lang.Object)">serialize</A></CODE> in class <CODE><A HREF="../../../../org/apache/xmlrpc/serializer/ExtSerializer.html" title="class in org.apache.xmlrpc.serializer">ExtSerializer</A></CODE></DL> 278</DD> 279<DD><DL> 280 281<DT><B>Throws:</B> 282<DD><CODE>org.xml.sax.SAXException</CODE></DL> 283</DD> 284</DL> 285<!-- ========= END OF CLASS DATA ========= --> 286<HR> 287 288 289<!-- ======= START OF BOTTOM NAVBAR ====== --> 290<A NAME="navbar_bottom"><!-- --></A> 291<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 292<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 293<TR> 294<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 295<A NAME="navbar_bottom_firstrow"><!-- --></A> 296<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 297 <TR ALIGN="center" VALIGN="top"> 298 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 299 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 300 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 301 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JaxbSerializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 302 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 303 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 304 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 305 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 306 </TR> 307</TABLE> 308</TD> 309<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 310</EM> 311</TD> 312</TR> 313 314<TR> 315<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 316 <A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbParser.html" title="class in org.apache.xmlrpc.jaxb"><B>PREV CLASS</B></A> 317 <A HREF="../../../../org/apache/xmlrpc/jaxb/JaxbTypeFactory.html" title="class in org.apache.xmlrpc.jaxb"><B>NEXT CLASS</B></A></FONT></TD> 318<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 319 <A HREF="../../../../index.html?org/apache/xmlrpc/jaxb/JaxbSerializer.html" target="_top"><B>FRAMES</B></A> 320 <A HREF="JaxbSerializer.html" target="_top"><B>NO FRAMES</B></A> 321 <SCRIPT type="text/javascript"> 322 <!-- 323 if(window==top) { 324 document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 325 } 326 //--> 327</SCRIPT> 328<NOSCRIPT> 329 <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> 330</NOSCRIPT> 331 332 333</FONT></TD> 334</TR> 335<TR> 336<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 337 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 338<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 339DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 340</TR> 341</TABLE> 342<A NAME="skip-navbar_bottom"></A> 343<!-- ======== END OF BOTTOM NAVBAR ======= --> 344 345<HR> 346Copyright © 2001-2009 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved. 347</BODY> 348</HTML>