documentserializableutilities.html

jxta的api库

                 java.lang.String&nbsp;rootTagName)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Write a DocumentSerializable object as an XML Document to a Stream
  
  The Root TagName will be 'documentSerializable' by default</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->


<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="DocumentSerializableUtilities()"><!-- --></A><H3>
DocumentSerializableUtilities</H3>
<PRE>
public <B>DocumentSerializableUtilities</B>()</PRE>
<DL>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="createStructuredXmlDocument(java.lang.String, net.jxta.util.documentSerializable.DocumentSerializable)"><!-- --></A><H3>
createStructuredXmlDocument</H3>
<PRE>
public static <A HREF="../../../../net/jxta/document/StructuredDocument.html" title="interface in net.jxta.document">StructuredDocument</A> <B>createStructuredXmlDocument</B>(java.lang.String&nbsp;docType,
                                                             <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A>&nbsp;documentSerializable)
                                                      throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Creates a Structured XML Document containing the serialized object
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The created Document
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE> - if Unable to parse the serialized object.</DL>
</DD>
</DL>
<HR>

<A NAME="copyChildren(net.jxta.document.Element, net.jxta.document.Element)"><!-- --></A><H3>
copyChildren</H3>
<PRE>
public static void <B>copyChildren</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;toElement,
                                <A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;fromElement)</PRE>
<DL>
<DD>Deeply copy an element into another element
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>toElement</CODE> - The target Element<DD><CODE>fromElement</CODE> - The source Element</DL>
</DD>
</DL>
<HR>

<A NAME="addDocumentSerializable(net.jxta.document.Element, java.lang.String, net.jxta.util.documentSerializable.DocumentSerializable)"><!-- --></A><H3>
addDocumentSerializable</H3>
<PRE>
public static void <B>addDocumentSerializable</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                           java.lang.String&nbsp;tagName,
                                           <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A>&nbsp;documentSerializable)
                                    throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Add an Element with the specified tagname and value (converted to a String)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - Parent Element that the new child element will be added to<DD><CODE>tagName</CODE> - TagName to be used for the created Child Element<DD><CODE>documentSerializable</CODE> - This value will be serialized into the created child element
\ 	 * @throws DocumentSerializationException if Unable to serialized object.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getDocumentSerializable(net.jxta.document.Element, java.lang.Class)"><!-- --></A><H3>
getDocumentSerializable</H3>
<PRE>
public static <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A> <B>getDocumentSerializable</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                                           java.lang.Class&nbsp;clazz)
                                                    throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Create an object from its Document Serialized components
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The relative root element of a Document Serialized Object<DD><CODE>clazz</CODE> - The Class of the resurrected object (must implement DocumentSerializable and have a public no-arg constructor)
<DT><B>Returns:</B><DD>An object of type 'clazz'
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE> - if Unable to parse the serialized object.</DL>
</DD>
</DL>
<HR>

<A NAME="getDocumentSerializable(net.jxta.document.Element, net.jxta.util.documentSerializable.DocumentSerializable)"><!-- --></A><H3>
getDocumentSerializable</H3>
<PRE>
public static <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A> <B>getDocumentSerializable</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                                           <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A>&nbsp;documentSerializable)
                                                    throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Initialize an object from its Document Serialized components
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The relative root element of a Document Serialized Object<DD><CODE>documentSerializable</CODE> - The object that will be populated from the Element
<DT><B>Returns:</B><DD>The same parameter passed to it 'documentSerializable'
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE> - if Unable to parse the serialized object.</DL>
</DD>
</DL>
<HR>

<A NAME="getDocumentSerializable(net.jxta.document.Element, java.lang.String, java.lang.Class)"><!-- --></A><H3>
getDocumentSerializable</H3>
<PRE>
public static <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A> <B>getDocumentSerializable</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                                           java.lang.String&nbsp;tagName,
                                                           java.lang.Class&nbsp;clazz)
                                                    throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Create an object from its Document Serialized components
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The Parent element which has a child Element with the serialized value<DD><CODE>tagName</CODE> - The tagname of the element that contains the relative root element of a Document Serialized Object<DD><CODE>clazz</CODE> - The Class of the resurrected object (must implement DocumentSerializable and have a public no-arg constructor)
<DT><B>Returns:</B><DD>An object of type 'clazz'
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE> - if Unable to parse the serialized object.</DL>
</DD>
</DL>
<HR>

<A NAME="copyDocumentSerializable(net.jxta.util.documentSerializable.DocumentSerializable)"><!-- --></A><H3>
copyDocumentSerializable</H3>
<PRE>
public static <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A> <B>copyDocumentSerializable</B>(<A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializable.html" title="interface in net.jxta.util.documentSerializable">DocumentSerializable</A>&nbsp;documentSerializable)
                                                     throws <A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></PRE>
<DL>
<DD>Create a copy of any Document Serializable object.
  
  This is done by serializing and then deserializing the object (ie not very efficient)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>documentSerializable</CODE> - The Object to be copied
<DT><B>Returns:</B><DD>An copy of the presented object
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../net/jxta/util/documentSerializable/DocumentSerializationException.html" title="class in net.jxta.util.documentSerializable">DocumentSerializationException</A></CODE> - if Unable to serialize or parse object.</DL>
</DD>
</DL>
<HR>

<A NAME="createChildElement(net.jxta.document.Element, java.lang.String)"><!-- --></A><H3>
createChildElement</H3>
<PRE>
public static <A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A> <B>createChildElement</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                         java.lang.String&nbsp;tagName)</PRE>
<DL>
<DD>Create a child element of the specified tagName
  
  This is done by serializing and then deserializing the object (ie not very efficient)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The Parent Element<DD><CODE>tagName</CODE> - The Tag Name for the new Element
<DT><B>Returns:</B><DD>The created Element</DL>
</DD>
</DL>
<HR>

<A NAME="getChildElement(net.jxta.document.Element, java.lang.String)"><!-- --></A><H3>
getChildElement</H3>
<PRE>
public static <A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A> <B>getChildElement</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                                      java.lang.String&nbsp;tagName)</PRE>
<DL>
<DD>Get a child element of the specified tagName
  
  This is done by serializing and then deserializing the object (ie not very efficient)
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>element</CODE> - The Parent Element<DD><CODE>tagName</CODE> - The Tag Name for the new Element
<DT><B>Returns:</B><DD>The found Element</DL>
</DD>
</DL>
<HR>

<A NAME="addInt(net.jxta.document.Element, java.lang.String, int)"><!-- --></A><H3>
addInt</H3>
<PRE>
public static void <B>addInt</B>(<A HREF="../../../../net/jxta/document/Element.html" title="interface in net.jxta.document">Element</A>&nbsp;element,
                          java.lang.String&nbsp;tagName,
                          int&nbsp;value)</PRE>
<DL>
<DD>Add an Element with the specified tagname and value (converted to a String)