blob: 1b96d795366e818181842067da7fbc550ceb9aa4 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc on Thu Nov 22 17:12:57 EST 2007 -->
<TITLE>
Xalan-Java 2.7.1: Class LSSerializerImpl
</TITLE>
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
</HEAD>
<BODY BGCOLOR="white">
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_top"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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/LSSerializerImpl.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/dom3/DOM3SerializerImpl.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/serializer/dom3/NamespaceSupport.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="LSSerializerImpl.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.apache.xml.serializer.dom3</FONT>
<BR>
Class LSSerializerImpl</H2>
<PRE>
java.lang.Object
|
+--<B>org.apache.xml.serializer.dom3.LSSerializerImpl</B>
</PRE>
<HR>
<DL>
<DT>public final class <B>LSSerializerImpl</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A>, <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A></DL>
<P>
Implemenatation of DOM Level 3 org.w3c.ls.LSSerializer and
org.w3c.dom.ls.DOMConfiguration. Serialization is achieved by delegating
serialization calls to <CODE>org.apache.xml.serializer.ToStream</CODE> or
one of its derived classes depending on the serialization method, while walking
the DOM in DOM3TreeWalker.
<P>
<DL>
<DT><B>See Also: </B><DD><a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-LS-20040407/load-save.html#LS-LSSerializer">org.w3c.dom.ls.LSSerializer</a>,
<a href="http://www.w3.org/TR/2004/REC-DOM-Level-3-Core-20040407/core.html#DOMConfiguration">org.w3c.dom.DOMConfiguration</a><DT><B>Usage:</B><DD><i><font size="-1" color="#FF0000"> **For internal use only**</font></i></DD>
</DD>
</DL>
<HR>
<P>
<!-- ======== INNER CLASS SUMMARY ======== -->
<!-- =========== FIELD SUMMARY =========== -->
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<A NAME="constructor_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Constructor Summary</B></FONT></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#LSSerializerImpl()">LSSerializerImpl</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor: Creates a LSSerializerImpl object.</TD>
</TR>
</TABLE>
&nbsp;
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=2><FONT SIZE="+2">
<B>Method Summary</B></FONT></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/dom3/LSSerializerImpl.html#canSetParameter(java.lang.String, java.lang.Object)">canSetParameter</A></B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if setting a parameter to a specific value is supported.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#getDomConfig()">getDomConfig</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the DOMConfiguration of the LSSerializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/w3c/dom/DOMErrorHandler.html">DOMErrorHandler</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#getErrorHandler()">getErrorHandler</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the LSSerializer's error handler.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/w3c/dom/ls/LSSerializerFilter.html">LSSerializerFilter</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#getFilter()">getFilter</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the DOMConfiguration of the LSSerializer.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#getNewLine()">getNewLine</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the End-Of-Line sequence of characters to be used in the XML
being serialized.</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/dom3/LSSerializerImpl.html#getParameter(java.lang.String)">getParameter</A></B>(java.lang.String&nbsp;name)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns the value of a parameter if known.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../../org/w3c/dom/DOMStringList.html">DOMStringList</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#getParameterNames()">getParameterNames</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method returns a of the parameters supported by this DOMConfiguration object
and for which at least one value can be set by the application</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/dom3/LSSerializerImpl.html#initializeSerializerProps()">initializeSerializerProps</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initializes the underlying serializer's configuration depending on the
default DOMConfiguration parameters.</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/dom3/LSSerializerImpl.html#setFilter(org.w3c.dom.ls.LSSerializerFilter)">setFilter</A></B>(<A HREF="../../../../../org/w3c/dom/ls/LSSerializerFilter.html">LSSerializerFilter</A>&nbsp;filter)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set a LSSerilizerFilter on the LSSerializer.</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/dom3/LSSerializerImpl.html#setNewLine(java.lang.String)">setNewLine</A></B>(java.lang.String&nbsp;newLine)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the End-Of-Line sequence of characters to be used in the XML
being 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/dom3/LSSerializerImpl.html#setParameter(java.lang.String, java.lang.Object)">setParameter</A></B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;This method sets the value of the named parameter.</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/dom3/LSSerializerImpl.html#write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)">write</A></B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg,
<A HREF="../../../../../org/w3c/dom/ls/LSOutput.html">LSOutput</A>&nbsp;destination)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serializes the specified node to the specified LSOutput and returns true if the Node
was successfully serialized.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/apache/xml/serializer/dom3/LSSerializerImpl.html#writeToString(org.w3c.dom.Node)">writeToString</A></B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serializes the specified node and returns a String with the serialized
data to the caller.</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/dom3/LSSerializerImpl.html#writeToURI(org.w3c.dom.Node, java.lang.String)">writeToURI</A></B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg,
java.lang.String&nbsp;uri)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Serializes the specified node to the specified URI and returns true if the Node
was successfully serialized.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>equals,
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" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="LSSerializerImpl()"><!-- --></A><H3>
LSSerializerImpl</H3>
<PRE>
public <B>LSSerializerImpl</B>()</PRE>
<DL>
<DD>Constructor: Creates a LSSerializerImpl object. The underlying
XML 1.0 or XML 1.1 org.apache.xml.serializer.Serializer object is
created and initialized the first time any of the write methods are
invoked to serialize the Node. Subsequent write methods on the same
LSSerializerImpl object will use the previously created Serializer object.</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>
<A NAME="initializeSerializerProps()"><!-- --></A><H3>
initializeSerializerProps</H3>
<PRE>
public void <B>initializeSerializerProps</B>()</PRE>
<DL>
<DD>Initializes the underlying serializer's configuration depending on the
default DOMConfiguration parameters. This method must be called before a
node is to be serialized.<DD><DL>
<DT><B>Usage:</B><DD><i><font size="-1" color="#FF0000"> **For internal use only**</font></i></DD>
</DD>
</DL>
</DD>
</DL>
<HR>
<A NAME="canSetParameter(java.lang.String, java.lang.Object)"><!-- --></A><H3>
canSetParameter</H3>
<PRE>
public boolean <B>canSetParameter</B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)</PRE>
<DL>
<DD>Checks if setting a parameter to a specific value is supported.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#canSetParameter(java.lang.String, java.lang.Object)">canSetParameter</A> in interface <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A><DT><B>Parameters:</B><DD><CODE>name</CODE> - A String containing the DOMConfiguration parameter name.<DD><CODE>value</CODE> - An Object specifying the value of the corresponding parameter.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#canSetParameter(java.lang.String, java.lang.Object)"><CODE>DOMConfiguration.canSetParameter(java.lang.String, java.lang.Object)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getParameter(java.lang.String)"><!-- --></A><H3>
getParameter</H3>
<PRE>
public java.lang.Object <B>getParameter</B>(java.lang.String&nbsp;name)
throws <A HREF="../../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE>
<DL>
<DD>This method returns the value of a parameter if known.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#getParameter(java.lang.String)">getParameter</A> in interface <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A><DT><B>Parameters:</B><DD><CODE>name</CODE> - A String containing the DOMConfiguration parameter name
whose value is to be returned.<DT><B>Returns:</B><DD>Object The value of the parameter if known.<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#getParameter(java.lang.String)"><CODE>DOMConfiguration.getParameter(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getParameterNames()"><!-- --></A><H3>
getParameterNames</H3>
<PRE>
public <A HREF="../../../../../org/w3c/dom/DOMStringList.html">DOMStringList</A> <B>getParameterNames</B>()</PRE>
<DL>
<DD>This method returns a of the parameters supported by this DOMConfiguration object
and for which at least one value can be set by the application<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#getParameterNames()">getParameterNames</A> in interface <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A><DT><B>Returns:</B><DD>DOMStringList A list of DOMConfiguration parameters recognized
by the serializer<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#getParameterNames()"><CODE>DOMConfiguration.getParameterNames()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setParameter(java.lang.String, java.lang.Object)"><!-- --></A><H3>
setParameter</H3>
<PRE>
public void <B>setParameter</B>(java.lang.String&nbsp;name,
java.lang.Object&nbsp;value)
throws <A HREF="../../../../../org/w3c/dom/DOMException.html">DOMException</A></PRE>
<DL>
<DD>This method sets the value of the named parameter.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#setParameter(java.lang.String, java.lang.Object)">setParameter</A> in interface <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A><DT><B>Parameters:</B><DD><CODE>name</CODE> - A String containing the DOMConfiguration parameter name.<DD><CODE>value</CODE> - An Object contaiing the parameters value to set.<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/DOMConfiguration.html#setParameter(java.lang.String, java.lang.Object)"><CODE>DOMConfiguration.setParameter(java.lang.String, java.lang.Object)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getDomConfig()"><!-- --></A><H3>
getDomConfig</H3>
<PRE>
public <A HREF="../../../../../org/w3c/dom/DOMConfiguration.html">DOMConfiguration</A> <B>getDomConfig</B>()</PRE>
<DL>
<DD>Returns the DOMConfiguration of the LSSerializer.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getDomConfig()">getDomConfig</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Returns:</B><DD>A DOMConfiguration object.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getDomConfig()"><CODE>LSSerializer.getDomConfig()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getFilter()"><!-- --></A><H3>
getFilter</H3>
<PRE>
public <A HREF="../../../../../org/w3c/dom/ls/LSSerializerFilter.html">LSSerializerFilter</A> <B>getFilter</B>()</PRE>
<DL>
<DD>Returns the DOMConfiguration of the LSSerializer.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getFilter()">getFilter</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Returns:</B><DD>A LSSerializerFilter object.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getFilter()"><CODE>LSSerializer.getFilter()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getNewLine()"><!-- --></A><H3>
getNewLine</H3>
<PRE>
public java.lang.String <B>getNewLine</B>()</PRE>
<DL>
<DD>Returns the End-Of-Line sequence of characters to be used in the XML
being serialized. If none is set a default "\n" is returned.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getNewLine()">getNewLine</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Returns:</B><DD>A String containing the end-of-line character sequence used in
serialization.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#getNewLine()"><CODE>LSSerializer.getNewLine()</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setFilter(org.w3c.dom.ls.LSSerializerFilter)"><!-- --></A><H3>
setFilter</H3>
<PRE>
public void <B>setFilter</B>(<A HREF="../../../../../org/w3c/dom/ls/LSSerializerFilter.html">LSSerializerFilter</A>&nbsp;filter)</PRE>
<DL>
<DD>Set a LSSerilizerFilter on the LSSerializer. When set, the filter is
called before each node is serialized which depending on its implemention
determines if the node is to be serialized or not.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#setFilter(org.w3c.dom.ls.LSSerializerFilter)">setFilter</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Parameters:</B><DD><CODE>filter</CODE> - A LSSerializerFilter to be applied to the stream to serialize.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#setFilter(org.w3c.dom.ls.LSSerializerFilter)"><CODE>LSSerializer.setFilter(org.w3c.dom.ls.LSSerializerFilter)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="setNewLine(java.lang.String)"><!-- --></A><H3>
setNewLine</H3>
<PRE>
public void <B>setNewLine</B>(java.lang.String&nbsp;newLine)</PRE>
<DL>
<DD>Sets the End-Of-Line sequence of characters to be used in the XML
being serialized. Setting this attribute to null will reset its
value to the default value i.e. "\n".<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#setNewLine(java.lang.String)">setNewLine</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Parameters:</B><DD><CODE>newLine</CODE> - a String that is the end-of-line character sequence to be used in
serialization.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#setNewLine(java.lang.String)"><CODE>LSSerializer.setNewLine(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)"><!-- --></A><H3>
write</H3>
<PRE>
public boolean <B>write</B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg,
<A HREF="../../../../../org/w3c/dom/ls/LSOutput.html">LSOutput</A>&nbsp;destination)
throws <A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
<DL>
<DD>Serializes the specified node to the specified LSOutput and returns true if the Node
was successfully serialized.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)">write</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Parameters:</B><DD><CODE>nodeArg</CODE> - The Node to serialize.<DT><B>Throws:</B><DD><A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A> - SERIALIZE_ERR: Raised if the
LSSerializer was unable to serialize the node.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)"><CODE>LSSerializer.write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="writeToString(org.w3c.dom.Node)"><!-- --></A><H3>
writeToString</H3>
<PRE>
public java.lang.String <B>writeToString</B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg)
throws <A HREF="../../../../../org/w3c/dom/DOMException.html">DOMException</A>,
<A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
<DL>
<DD>Serializes the specified node and returns a String with the serialized
data to the caller.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#writeToString(org.w3c.dom.Node)">writeToString</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Parameters:</B><DD><CODE>nodeArg</CODE> - The Node to serialize.<DT><B>Throws:</B><DD><A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A> - SERIALIZE_ERR: Raised if the
LSSerializer was unable to serialize the node.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#writeToString(org.w3c.dom.Node)"><CODE>LSSerializer.writeToString(org.w3c.dom.Node)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="writeToURI(org.w3c.dom.Node, java.lang.String)"><!-- --></A><H3>
writeToURI</H3>
<PRE>
public boolean <B>writeToURI</B>(<A HREF="../../../../../org/w3c/dom/Node.html">Node</A>&nbsp;nodeArg,
java.lang.String&nbsp;uri)
throws <A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A></PRE>
<DL>
<DD>Serializes the specified node to the specified URI and returns true if the Node
was successfully serialized.<DD><DL>
<DT><B>Specified by: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#writeToURI(org.w3c.dom.Node, java.lang.String)">writeToURI</A> in interface <A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html">LSSerializer</A><DT><B>Parameters:</B><DD><CODE>nodeArg</CODE> - The Node to serialize.<DT><B>Throws:</B><DD><A HREF="../../../../../org/w3c/dom/ls/LSException.html">LSException</A> - SERIALIZE_ERR: Raised if the
LSSerializer was unable to serialize the node.<DT><B>Since: </B><DD>DOM Level 3</DD>
<DT><B>See Also: </B><DD><A HREF="../../../../../org/w3c/dom/ls/LSSerializer.html#writeToURI(org.w3c.dom.Node, java.lang.String)"><CODE>LSSerializer.writeToURI(org.w3c.dom.Node, String)</CODE></A></DL>
</DD>
</DL>
<HR>
<A NAME="getErrorHandler()"><!-- --></A><H3>
getErrorHandler</H3>
<PRE>
public <A HREF="../../../../../org/w3c/dom/DOMErrorHandler.html">DOMErrorHandler</A> <B>getErrorHandler</B>()</PRE>
<DL>
<DD>This method returns the LSSerializer's error handler.<DD><DL>
<DT><B>Returns:</B><DD>Returns the fDOMErrorHandler.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ========== START OF NAVBAR ========== -->
<A NAME="navbar_bottom"><!-- --></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
<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/LSSerializerImpl.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/dom3/DOM3SerializerImpl.html"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../org/apache/xml/serializer/dom3/NamespaceSupport.html"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="LSSerializerImpl.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<!-- =========== END OF NAVBAR =========== -->
<HR>
Copyright © 2006 Apache XML Project. All Rights Reserved.
</BODY>
</HTML>