Google Git
Sign in
apache / xalan-site / 1b0c6dd5447f3bc951dcdd0e155aae8fc8efd4de / . / xalan-j / apidocs / org / apache / xml / serializer / Serializer.html
blob: 299c791d045b215da8678b6075f2d67fe76a9dc8 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.5.0_18) on Sun Apr 01 21:18:35 PDT 2012 -->
<TITLE>
Serializer
</TITLE>
<META NAME="keywords" CONTENT="org.apache.xml.serializer.Serializer interface">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
parent.document.title="Serializer";
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Serializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/serializer/SerializerBase.html" title="class in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/serializer/Serializer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Serializer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xml.serializer</FONT>
<BR>
Interface Serializer</H2>
<DL>
<DT><B>All Known Subinterfaces:</B> <DD><A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer">SerializationHandler</A></DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/xalan/xsltc/dom/AdaptiveResultTreeImpl.html" title="class in org.apache.xalan.xsltc.dom">AdaptiveResultTreeImpl</A>, <A HREF="../../../../org/apache/xml/serializer/EmptySerializer.html" title="class in org.apache.xml.serializer">EmptySerializer</A>, <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html" title="class in org.apache.xml.serializer">SerializerBase</A>, <A HREF="../../../../org/apache/xalan/xsltc/dom/SimpleResultTreeImpl.html" title="class in org.apache.xalan.xsltc.dom">SimpleResultTreeImpl</A>, <A HREF="../../../../org/apache/xalan/xsltc/runtime/StringValueHandler.html" title="class in org.apache.xalan.xsltc.runtime">StringValueHandler</A>, <A HREF="../../../../org/apache/xml/serializer/ToHTMLSAXHandler.html" title="class in org.apache.xml.serializer">ToHTMLSAXHandler</A>, <A HREF="../../../../org/apache/xml/serializer/ToHTMLStream.html" title="class in org.apache.xml.serializer">ToHTMLStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToSAXHandler.html" title="class in org.apache.xml.serializer">ToSAXHandler</A>, <A HREF="../../../../org/apache/xml/serializer/ToStream.html" title="class in org.apache.xml.serializer">ToStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToTextSAXHandler.html" title="class in org.apache.xml.serializer">ToTextSAXHandler</A>, <A HREF="../../../../org/apache/xml/serializer/ToTextStream.html" title="class in org.apache.xml.serializer">ToTextStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToUnknownStream.html" title="class in org.apache.xml.serializer">ToUnknownStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToXMLSAXHandler.html" title="class in org.apache.xml.serializer">ToXMLSAXHandler</A>, <A HREF="../../../../org/apache/xml/serializer/ToXMLStream.html" title="class in org.apache.xml.serializer">ToXMLStream</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.91"><B>Serializer</B></A></DL>
</PRE>
<P>
The Serializer interface is implemented by a serializer to enable users to:
<ul>
<li>get and set streams or writers
<li>configure the serializer with key/value properties
<li>get an org.xml.sax.ContentHandler or a DOMSerializer to provide input to
</ul>
<p>
Here is an example using the asContentHandler() method:
<pre>
java.util.Properties props =
OutputPropertiesFactory.getDefaultMethodProperties(Method.TEXT);
Serializer ser = SerializerFactory.getSerializer(props);
java.io.PrintStream ostream = System.out;
ser.setOutputStream(ostream);
// Provide the SAX input events
ContentHandler handler = ser.asContentHandler();
handler.startDocument();
char[] chars = { 'a', 'b', 'c' };
handler.characters(chars, 0, chars.length);
handler.endDocument();
ser.reset(); // get ready to use the serializer for another document
// of the same output method (TEXT).
</pre>
<p>
As an alternate to supplying a series of SAX events as input through the
ContentHandler interface, the input to serialize may be given as a DOM.
<p>
For example:
<pre>
org.w3c.dom.Document inputDoc;
org.apache.xml.serializer.Serializer ser;
java.io.Writer owriter;
java.util.Properties props =
OutputPropertiesFactory.getDefaultMethodProperties(Method.XML);
Serializer ser = SerializerFactory.getSerializer(props);
owriter = ...; // create a writer to serialize the document to
ser.setWriter( owriter );
inputDoc = ...; // create the DOM document to be serialized
DOMSerializer dser = ser.asDOMSerializer(); // a DOM will be serialized
dser.serialize(inputDoc); // serialize the DOM, sending output to owriter
ser.reset(); // get ready to use the serializer for another document
// of the same output method.
</pre>
This interface is a public API.
<P>
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/xml/serializer/Method.html" title="class in org.apache.xml.serializer"><CODE>Method</CODE></A>,
<A HREF="../../../../org/apache/xml/serializer/OutputPropertiesFactory.html" title="class in org.apache.xml.serializer"><CODE>OutputPropertiesFactory</CODE></A>,
<A HREF="../../../../org/apache/xml/serializer/SerializerFactory.html" title="class in org.apache.xml.serializer"><CODE>SerializerFactory</CODE></A>,
<A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><CODE>DOMSerializer</CODE></A>,
<CODE>ContentHandler</CODE></DL>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;org.xml.sax.ContentHandler</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#asContentHandler()">asContentHandler</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <CODE>ContentHandler</CODE> interface to provide SAX input to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#asDOM3Serializer()">asDOM3Serializer</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return an Object into this serializer to be cast to a DOM3Serializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer">DOMSerializer</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#asDOMSerializer()">asDOMSerializer</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Return a <A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><CODE>DOMSerializer</CODE></A> interface into this serializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.util.Properties</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#getOutputFormat()">getOutputFormat</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the output format properties for this serializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.OutputStream</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#getOutputStream()">getOutputStream</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the output stream where the events will be serialized to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.io.Writer</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#getWriter()">getWriter</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the character stream where the events will be serialized to.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#reset()">reset</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method resets the serializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#setOutputFormat(java.util.Properties)">setOutputFormat</A></B>(java.util.Properties&nbsp;format)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies an output format for this serializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#setOutputStream(java.io.OutputStream)">setOutputStream</A></B>(java.io.OutputStream&nbsp;output)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies an output stream to which the document should be
serialized.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/Serializer.html#setWriter(java.io.Writer)">setWriter</A></B>(java.io.Writer&nbsp;writer)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Specifies a writer to which the document should be serialized.</TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="setOutputStream(java.io.OutputStream)"><!-- --></A><H3>
setOutputStream</H3>
<PRE>
void <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.106"><B>setOutputStream</B></A>(java.io.OutputStream&nbsp;output)</PRE>
<DL>
<DD>Specifies an output stream to which the document should be
serialized. This method should not be called while the
serializer is in the process of serializing a document.
<p>
The encoding specified in the output <CODE>Properties</CODE> is used, or
if no encoding was specified, the default for the selected
output method.
<p>
Only one of setWriter() or setOutputStream() should be called.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>output</CODE> - The output stream</DL>
</DD>
</DL>
<HR>
<A NAME="getOutputStream()"><!-- --></A><H3>
getOutputStream</H3>
<PRE>
java.io.OutputStream <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.114"><B>getOutputStream</B></A>()</PRE>
<DL>
<DD>Get the output stream where the events will be serialized to.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>reference to the result stream, or null if only a writer was
set.</DL>
</DD>
</DL>
<HR>
<A NAME="setWriter(java.io.Writer)"><!-- --></A><H3>
setWriter</H3>
<PRE>
void <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.129"><B>setWriter</B></A>(java.io.Writer&nbsp;writer)</PRE>
<DL>
<DD>Specifies a writer to which the document should be serialized.
This method should not be called while the serializer is in
the process of serializing a document.
<p>
The encoding specified for the output <CODE>Properties</CODE> must be
identical to the output format used with the writer.
<p>
Only one of setWriter() or setOutputStream() should be called.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>writer</CODE> - The output writer stream</DL>
</DD>
</DL>
<HR>
<A NAME="getWriter()"><!-- --></A><H3>
getWriter</H3>
<PRE>
java.io.Writer <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.136"><B>getWriter</B></A>()</PRE>
<DL>
<DD>Get the character stream where the events will be serialized to.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>Reference to the result Writer, or null.</DL>
</DD>
</DL>
<HR>
<A NAME="setOutputFormat(java.util.Properties)"><!-- --></A><H3>
setOutputFormat</H3>
<PRE>
void <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.169"><B>setOutputFormat</B></A>(java.util.Properties&nbsp;format)</PRE>
<DL>
<DD>Specifies an output format for this serializer. It the
serializer has already been associated with an output format,
it will switch to the new format. This method should not be
called while the serializer is in the process of serializing
a document.
<p>
The standard property keys supported are: "method", "version", "encoding",
"omit-xml-declaration", "standalone", doctype-public",
"doctype-system", "cdata-section-elements", "indent", "media-type".
These property keys and their values are described in the XSLT recommendation,
see <a href="http://www.w3.org/TR/1999/REC-xslt-19991116"> XSLT 1.0 recommendation</a>
<p>
The non-standard property keys supported are defined in <A HREF="../../../../org/apache/xml/serializer/OutputPropertiesFactory.html" title="class in org.apache.xml.serializer"><CODE>OutputPropertiesFactory</CODE></A>.
<p>
This method can be called multiple times before a document is serialized. Each
time it is called more, or over-riding property values, can be specified. One
property value that can not be changed is that of the "method" property key.
<p>
The value of the "cdata-section-elements" property key is a whitespace
separated list of elements. If the element is in a namespace then
value is passed in this format: {uri}localName
<p>
If the "cdata-section-elements" key is specified on multiple calls
to this method the set of elements specified in the value
is not replaced from one call to the
next, but it is cumulative across the calls.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>format</CODE> - The output format to use, as a set of key/value pairs.</DL>
</DD>
</DL>
<HR>
<A NAME="getOutputFormat()"><!-- --></A><H3>
getOutputFormat</H3>
<PRE>
java.util.Properties <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.176"><B>getOutputFormat</B></A>()</PRE>
<DL>
<DD>Returns the output format properties for this serializer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>The output format key/value pairs in use.</DL>
</DD>
</DL>
<HR>
<A NAME="asContentHandler()"><!-- --></A><H3>
asContentHandler</H3>
<PRE>
org.xml.sax.ContentHandler <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.192"><B>asContentHandler</B></A>()
throws java.io.IOException</PRE>
<DL>
<DD>Return a <CODE>ContentHandler</CODE> interface to provide SAX input to.
Through the returned object the document to be serailized,
as a series of SAX events, can be provided to the serialzier.
If the serializer does not support the <CODE>ContentHandler</CODE>
interface, it will return null.
<p>
In principle only one of asDOMSerializer() or asContentHander()
should be called.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A <CODE>ContentHandler</CODE> interface into this serializer,
or null if the serializer is not SAX 2 capable
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - An I/O exception occured</DL>
</DD>
</DL>
<HR>
<A NAME="asDOMSerializer()"><!-- --></A><H3>
asDOMSerializer</H3>
<PRE>
<A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer">DOMSerializer</A> <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.208"><B>asDOMSerializer</B></A>()
throws java.io.IOException</PRE>
<DL>
<DD>Return a <A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><CODE>DOMSerializer</CODE></A> interface into this serializer.
Through the returned object the document to be serialized,
a DOM, can be provided to the serializer.
If the serializer does not support the <A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><CODE>DOMSerializer</CODE></A>
interface, it should return null.
<p>
In principle only one of asDOMSerializer() or asContentHander()
should be called.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>A <A HREF="../../../../org/apache/xml/serializer/DOMSerializer.html" title="interface in org.apache.xml.serializer"><CODE>DOMSerializer</CODE></A> interface into this serializer,
or null if the serializer is not DOM capable
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - An I/O exception occured</DL>
</DD>
</DL>
<HR>
<A NAME="reset()"><!-- --></A><H3>
reset</H3>
<PRE>
boolean <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.220"><B>reset</B></A>()</PRE>
<DL>
<DD>This method resets the serializer.
If this method returns true, the
serializer may be used for subsequent serialization of new
documents. It is possible to change the output format and
output stream prior to serializing, or to reuse the existing
output format and output stream or writer.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>True if serializer has been reset and can be reused</DL>
</DD>
</DL>
<HR>
<A NAME="asDOM3Serializer()"><!-- --></A><H3>
asDOM3Serializer</H3>
<PRE>
java.lang.Object <A HREF="../../../../src-html/org/apache/xml/serializer/Serializer.html#line.236"><B>asDOM3Serializer</B></A>()
throws java.io.IOException</PRE>
<DL>
<DD>Return an Object into this serializer to be cast to a DOM3Serializer.
Through the returned object the document to be serialized,
a DOM (Level 3), can be provided to the serializer.
If the serializer does not support casting to a <A HREF="../../../../org/apache/xml/serializer/DOM3Serializer.html" title="interface in org.apache.xml.serializer"><CODE>DOM3Serializer</CODE></A>
interface, it should return null.
<p>
In principle only one of asDOM3Serializer() or asContentHander()
should be called.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>An Object to be cast to a DOM3Serializer interface into this serializer,
or null if the serializer is not DOM capable
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - An I/O exception occured</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Serializer.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html" title="interface in org.apache.xml.serializer"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/apache/xml/serializer/SerializerBase.html" title="class in org.apache.xml.serializer"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../index.html?org/apache/xml/serializer/Serializer.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="Serializer.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>