| <!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 ToStream
|
| </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> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ToStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/serializer/ToSAXHandler.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/serializer/ToTextSAXHandler.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>
|
| <A HREF="ToStream.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#fields_inherited_from_class_org.apache.xml.serializer.SerializerBase">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <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</FONT>
|
| <BR>
|
| Class ToStream</H2>
|
| <PRE>
|
| java.lang.Object
|
| |
|
| +--<A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">org.apache.xml.serializer.SerializerBase</A>
|
| |
|
| +--<B>org.apache.xml.serializer.ToStream</B>
|
| </PRE>
|
| <DL>
|
| <DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../org/apache/xml/serializer/ToHTMLStream.html">ToHTMLStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToTextStream.html">ToTextStream</A>, <A HREF="../../../../org/apache/xml/serializer/ToXMLStream.html">ToXMLStream</A></DD>
|
| </DL>
|
| <HR>
|
| <DL>
|
| <DT>public abstract class <B>ToStream</B><DT>extends <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
|
|
| <P>
|
| This abstract class is a base class for other stream |
| serializers (xml, html, text ...) that write output to a stream.
|
| <P>
|
| <DL>
|
| <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 =========== -->
|
|
|
| <A NAME="fields_inherited_from_class_org.apache.xml.serializer.SerializerBase"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Fields inherited from class org.apache.xml.serializer.<A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#PKG_NAME">PKG_NAME</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#PKG_PATH">PKG_PATH</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ======== 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/ToStream.html#ToStream()">ToStream</A></B>()</CODE>
|
|
|
| <BR>
|
| Default constructor</TD>
|
| </TR>
|
| </TABLE>
|
|
|
| <!-- ========== 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> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#addAttributeAlways(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)">addAttributeAlways</A></B>(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean xslAttribute)</CODE>
|
|
|
| <BR>
|
| Adds the given attribute to the set of attributes, even if there is |
| no currently open element.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#addCdataSectionElements(java.lang.String)">addCdataSectionElements</A></B>(java.lang.String URI_and_localNames)</CODE>
|
|
|
| <BR>
|
| Remembers the cdata sections specified in the cdata-section-elements by appending the given |
| cdata section elements to the list.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">attributeDecl</A></B>(java.lang.String eName, |
| java.lang.String aName, |
| java.lang.String type, |
| java.lang.String valueDefault, |
| java.lang.String value)</CODE>
|
|
|
| <BR>
|
| Report an attribute type declaration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#characters(char[], int, int)">characters</A></B>(char[] chars, |
| int start, |
| int length)</CODE>
|
|
|
| <BR>
|
| Receive notification of character data.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#characters(java.lang.String)">characters</A></B>(java.lang.String s)</CODE>
|
|
|
| <BR>
|
| Receive notification of character data.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#comment(char[], int, int)">comment</A></B>(char[] ch, |
| int start, |
| int length)</CODE>
|
|
|
| <BR>
|
| Receive notification of an XML comment anywhere in the document.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#elementDecl(java.lang.String, java.lang.String)">elementDecl</A></B>(java.lang.String name, |
| java.lang.String model)</CODE>
|
|
|
| <BR>
|
| Report an element type declaration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endCDATA()">endCDATA</A></B>()</CODE>
|
|
|
| <BR>
|
| Report the end of a CDATA section.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endDTD()">endDTD</A></B>()</CODE>
|
|
|
| <BR>
|
| Report the end of DTD declarations.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endElement(java.lang.String)">endElement</A></B>(java.lang.String name)</CODE>
|
|
|
| <BR>
|
| Receive notification of the end of an element.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endElement(java.lang.String, java.lang.String, java.lang.String)">endElement</A></B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String name)</CODE>
|
|
|
| <BR>
|
| Receive notification of the end of an element.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endNonEscaping()">endNonEscaping</A></B>()</CODE>
|
|
|
| <BR>
|
| Ends an un-escaping section.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endPrefixMapping(java.lang.String)">endPrefixMapping</A></B>(java.lang.String prefix)</CODE>
|
|
|
| <BR>
|
| End the scope of a prefix-URI Namespace mapping.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)">externalEntityDecl</A></B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId)</CODE>
|
|
|
| <BR>
|
| Report a parsed external entity declaration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#flushPending()">flushPending</A></B>()</CODE>
|
|
|
| <BR>
|
| This method flushes any pending events, which can be startDocument() |
| closing the opening tag of an element, or closing an open CDATA section.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> int</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#getIndentAmount()">getIndentAmount</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the m_indentAmount.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.util.Properties</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#getOutputFormat()">getOutputFormat</A></B>()</CODE>
|
|
|
| <BR>
|
| Returns the output format for this serializer.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> java.io.OutputStream</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#getOutputStream()">getOutputStream</A></B>()</CODE>
|
|
|
| <BR>
|
| 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> java.io.Writer</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#getWriter()">getWriter</A></B>()</CODE>
|
|
|
| <BR>
|
| 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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#ignorableWhitespace(char[], int, int)">ignorableWhitespace</A></B>(char[] ch, |
| int start, |
| int length)</CODE>
|
|
|
| <BR>
|
| Receive notification of ignorable whitespace in element content.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#internalEntityDecl(java.lang.String, java.lang.String)">internalEntityDecl</A></B>(java.lang.String name, |
| java.lang.String value)</CODE>
|
|
|
| <BR>
|
| Report an internal entity declaration.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#notationDecl(java.lang.String, java.lang.String, java.lang.String)">notationDecl</A></B>(java.lang.String name, |
| java.lang.String pubID, |
| java.lang.String sysID)</CODE>
|
|
|
| <BR>
|
| If this method is called, the serializer is used as a |
| DTDHandler, which changes behavior how the serializer |
| handles document entities.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#processAttributes(java.io.Writer, int)">processAttributes</A></B>(java.io.Writer writer, |
| int nAttrs)</CODE>
|
|
|
| <BR>
|
| Process the attributes, which means to write out the currently |
| collected attributes to the writer.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#reset()">reset</A></B>()</CODE>
|
|
|
| <BR>
|
| Try's to reset the super class and reset this class for |
| re-use, so that you don't need to create a new serializer |
| (mostly for performance reasons).</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#serialize(org.w3c.dom.Node)">serialize</A></B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> node)</CODE>
|
|
|
| <BR>
|
| Serializes the DOM node.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setCdataSectionElements(java.util.Vector)">setCdataSectionElements</A></B>(java.util.Vector URI_and_localNames)</CODE>
|
|
|
| <BR>
|
| Remembers the cdata sections specified in the cdata-section-elements.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setContentHandler(org.xml.sax.ContentHandler)">setContentHandler</A></B>(<A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setDTDEntityExpansion(boolean)">setDTDEntityExpansion</A></B>(boolean expand)</CODE>
|
|
|
| <BR>
|
| If set to false the serializer does not expand DTD entities, |
| but leaves them as is, the default value is true;</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setEncoding(java.lang.String)">setEncoding</A></B>(java.lang.String encoding)</CODE>
|
|
|
| <BR>
|
| Sets the character encoding coming from the xsl:output encoding stylesheet attribute.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setEscaping(boolean)">setEscaping</A></B>(boolean escape)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setIndentAmount(int)">setIndentAmount</A></B>(int m_indentAmount)</CODE>
|
|
|
| <BR>
|
| Sets the m_indentAmount.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setLineSepUse(boolean)">setLineSepUse</A></B>(boolean use_sytem_line_break)</CODE>
|
|
|
| <BR>
|
| Set if the operating systems end-of-line line separator should |
| be used when serializing.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setNewLine(char[])">setNewLine</A></B>(char[] eolChars)</CODE>
|
|
|
| <BR>
|
| Sets the end of line characters to be used during serialization</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setOutputFormat(java.util.Properties)">setOutputFormat</A></B>(java.util.Properties format)</CODE>
|
|
|
| <BR>
|
| 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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setOutputStream(java.io.OutputStream)">setOutputStream</A></B>(java.io.OutputStream output)</CODE>
|
|
|
| <BR>
|
| 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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setTransformer(javax.xml.transform.Transformer)">setTransformer</A></B>(<A HREF="../../../../javax/xml/transform/Transformer.html">Transformer</A> transformer)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#setWriter(java.io.Writer)">setWriter</A></B>(java.io.Writer writer)</CODE>
|
|
|
| <BR>
|
| Specifies a writer 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> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#skippedEntity(java.lang.String)">skippedEntity</A></B>(java.lang.String name)</CODE>
|
|
|
| <BR>
|
| Receive notification of a skipped entity.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startCDATA()">startCDATA</A></B>()</CODE>
|
|
|
| <BR>
|
| Report the start of a CDATA section.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startDTD(java.lang.String, java.lang.String, java.lang.String)">startDTD</A></B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId)</CODE>
|
|
|
| <BR>
|
| Report the start of DTD declarations, if any.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startElement(java.lang.String)">startElement</A></B>(java.lang.String elementName)</CODE>
|
|
|
| <BR>
|
| </TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startElement(java.lang.String, java.lang.String, java.lang.String)">startElement</A></B>(java.lang.String elementNamespaceURI, |
| java.lang.String elementLocalName, |
| java.lang.String elementName)</CODE>
|
|
|
| <BR>
|
| Receive notification of the beginning of an element, additional |
| namespace or attribute information can occur before or after this call, |
| that is associated with this element.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)">startElement</A></B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String name, |
| <A HREF="../../../../org/xml/sax/Attributes.html">Attributes</A> atts)</CODE>
|
|
|
| <BR>
|
| Receive notification of the beginning of an element, although this is a |
| SAX method additional namespace or attribute information can occur before |
| or after this call, that is associated with this element.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startEntity(java.lang.String)">startEntity</A></B>(java.lang.String name)</CODE>
|
|
|
| <BR>
|
| Report the beginning of an entity.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startNonEscaping()">startNonEscaping</A></B>()</CODE>
|
|
|
| <BR>
|
| Starts an un-escaping section.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startPrefixMapping(java.lang.String, java.lang.String)">startPrefixMapping</A></B>(java.lang.String prefix, |
| java.lang.String uri)</CODE>
|
|
|
| <BR>
|
| Begin the scope of a prefix-URI Namespace mapping |
| just before another element is about to start.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> boolean</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startPrefixMapping(java.lang.String, java.lang.String, boolean)">startPrefixMapping</A></B>(java.lang.String prefix, |
| java.lang.String uri, |
| boolean shouldFlush)</CODE>
|
|
|
| <BR>
|
| Handle a prefix/uri mapping, which is associated with a startElement() |
| that is soon to follow.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">unparsedEntityDecl</A></B>(java.lang.String name, |
| java.lang.String pubID, |
| java.lang.String sysID, |
| java.lang.String notationName)</CODE>
|
|
|
| <BR>
|
| If this method is called, the serializer is used as a |
| DTDHandler, which changes behavior how the serializer |
| handles document entities.</TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
| <CODE> void</CODE></FONT></TD>
|
| <TD><CODE><B><A HREF="../../../../org/apache/xml/serializer/ToStream.html#writeAttrString(java.io.Writer, java.lang.String, java.lang.String)">writeAttrString</A></B>(java.io.Writer writer, |
| java.lang.String string, |
| java.lang.String encoding)</CODE>
|
|
|
| <BR>
|
| Returns the specified <var>string</var> after substituting <VAR>specials</VAR>, |
| and UTF-16 surrogates for chracter references <CODE>&#xnn</CODE>.</TD>
|
| </TR>
|
| </TABLE>
|
| <A NAME="methods_inherited_from_class_org.apache.xml.serializer.SerializerBase"><!-- --></A> |
| <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
|
| <TD><B>Methods inherited from class org.apache.xml.serializer.<A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></B></TD>
|
| </TR>
|
| <TR BGCOLOR="white" CLASS="TableRowColor">
|
| <TD><CODE><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute(java.lang.String, java.lang.String)">addAttribute</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">addAttribute</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addAttribute(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)">addAttribute</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addAttributes(org.xml.sax.Attributes)">addAttributes</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addXSLAttribute(java.lang.String, java.lang.String, java.lang.String)">addXSLAttribute</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#asContentHandler()">asContentHandler</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#asDOM3Serializer()">asDOM3Serializer</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#asDOMSerializer()">asDOMSerializer</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#characters(org.w3c.dom.Node)">characters</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#close()">close</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#comment(java.lang.String)">comment</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#documentIsEmpty()">documentIsEmpty</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#endEntity(java.lang.String)">endEntity</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#entityReference(java.lang.String)">entityReference</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#error(org.xml.sax.SAXParseException)">error</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#fatalError(org.xml.sax.SAXParseException)">fatalError</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#fireEndEntity(java.lang.String)">fireEndEntity</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getDoctypePublic()">getDoctypePublic</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getDoctypeSystem()">getDoctypeSystem</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getEncoding()">getEncoding</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getIndent()">getIndent</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getMediaType()">getMediaType</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceMappings()">getNamespaceMappings</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceURI(java.lang.String, boolean)">getNamespaceURI</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getNamespaceURIFromPrefix(java.lang.String)">getNamespaceURIFromPrefix</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getOmitXMLDeclaration()">getOmitXMLDeclaration</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputProperty(java.lang.String)">getOutputProperty</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputPropertyDefault(java.lang.String)">getOutputPropertyDefault</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getOutputPropertyNonDefault(java.lang.String)">getOutputPropertyNonDefault</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getPrefix(java.lang.String)">getPrefix</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getStandalone()">getStandalone</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getTransformer()">getTransformer</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getVersion()">getVersion</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#namespaceAfterStartElement(java.lang.String, java.lang.String)">namespaceAfterStartElement</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctype(java.lang.String, java.lang.String)">setDoctype</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctypePublic(java.lang.String)">setDoctypePublic</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setDoctypeSystem(java.lang.String)">setDoctypeSystem</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setDocumentLocator(org.xml.sax.Locator)">setDocumentLocator</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setIndent(boolean)">setIndent</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setMediaType(java.lang.String)">setMediaType</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setNamespaceMappings(org.apache.xml.serializer.NamespaceMappings)">setNamespaceMappings</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setOmitXMLDeclaration(boolean)">setOmitXMLDeclaration</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setOutputProperty(java.lang.String, java.lang.String)">setOutputProperty</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setOutputPropertyDefault(java.lang.String, java.lang.String)">setOutputPropertyDefault</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setSourceLocator(javax.xml.transform.SourceLocator)">setSourceLocator</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setStandalone(java.lang.String)">setStandalone</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setVersion(java.lang.String)">setVersion</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#startDocument()">startDocument</A>,
|
| <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#warning(org.xml.sax.SAXParseException)">warning</A></CODE></TD>
|
| </TR>
|
| </TABLE>
|
| <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>
|
|
|
| <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="ToStream()"><!-- --></A><H3>
|
| ToStream</H3>
|
| <PRE>
|
| public <B>ToStream</B>()</PRE>
|
| <DL>
|
| <DD>Default constructor</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="serialize(org.w3c.dom.Node)"><!-- --></A><H3>
|
| serialize</H3>
|
| <PRE>
|
| public void <B>serialize</B>(<A HREF="../../../../org/w3c/dom/Node.html">Node</A> node) |
| throws java.io.IOException</PRE>
|
| <DL>
|
| <DD>Serializes the DOM node. Throws an exception only if an I/O |
| exception occured while serializing.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>node</CODE> - Node to serialize.<DT><B>Throws:</B><DD>java.io.IOException - An I/O exception occured while serializing</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getOutputStream()"><!-- --></A><H3>
|
| getOutputStream</H3>
|
| <PRE>
|
| public java.io.OutputStream <B>getOutputStream</B>()</PRE>
|
| <DL>
|
| <DD>Get the output stream where the events will be serialized to.<DD><DL>
|
| <DT><B>Returns:</B><DD>reference to the result stream, or null of only a writer was |
| set.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="elementDecl(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| elementDecl</H3>
|
| <PRE>
|
| public void <B>elementDecl</B>(java.lang.String name, |
| java.lang.String model) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report an element type declaration. |
| |
| <p>The content model will consist of the string "EMPTY", the |
| string "ANY", or a parenthesised group, optionally followed |
| by an occurrence indicator. The model will be normalized so |
| that all whitespace is removed,and will include the enclosing |
| parentheses.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The element type name.<DD><CODE>model</CODE> - The content model as a normalized string.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="internalEntityDecl(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| internalEntityDecl</H3>
|
| <PRE>
|
| public void <B>internalEntityDecl</B>(java.lang.String name, |
| java.lang.String value) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report an internal entity declaration. |
| |
| <p>Only the effective (first) declaration for each entity |
| will be reported.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the entity. If it is a parameter |
| entity, the name will begin with '%'.<DD><CODE>value</CODE> - The replacement text of the entity.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)"><CODE>externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/DTDHandler.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><CODE>DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setOutputFormat(java.util.Properties)"><!-- --></A><H3>
|
| setOutputFormat</H3>
|
| <PRE>
|
| public void <B>setOutputFormat</B>(java.util.Properties 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.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>format</CODE> - The output format to use</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getOutputFormat()"><!-- --></A><H3>
|
| getOutputFormat</H3>
|
| <PRE>
|
| public java.util.Properties <B>getOutputFormat</B>()</PRE>
|
| <DL>
|
| <DD>Returns the output format for this serializer.<DD><DL>
|
| <DT><B>Returns:</B><DD>The output format in use</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setWriter(java.io.Writer)"><!-- --></A><H3>
|
| setWriter</H3>
|
| <PRE>
|
| public void <B>setWriter</B>(java.io.Writer 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.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>writer</CODE> - The output writer stream</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setLineSepUse(boolean)"><!-- --></A><H3>
|
| setLineSepUse</H3>
|
| <PRE>
|
| public boolean <B>setLineSepUse</B>(boolean use_sytem_line_break)</PRE>
|
| <DL>
|
| <DD>Set if the operating systems end-of-line line separator should |
| be used when serializing. If set false NL character |
| (decimal 10) is left alone, otherwise the new-line will be replaced on |
| output with the systems line separator. For example on UNIX this is |
| NL, while on Windows it is two characters, CR NL, where CR is the |
| carriage-return (decimal 13).<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>use_sytem_line_break</CODE> - True if an input NL is replaced with the |
| operating systems end-of-line separator.<DT><B>Returns:</B><DD>The previously set value of the serializer.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setOutputStream(java.io.OutputStream)"><!-- --></A><H3>
|
| setOutputStream</H3>
|
| <PRE>
|
| public void <B>setOutputStream</B>(java.io.OutputStream 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 properties is used, or |
| if no encoding was specified, the default for the selected |
| output method.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>output</CODE> - The output stream</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setEscaping(boolean)"><!-- --></A><H3>
|
| setEscaping</H3>
|
| <PRE>
|
| public boolean <B>setEscaping</B>(boolean escape)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html#setEscaping(boolean)"><CODE>SerializationHandler.setEscaping(boolean)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="attributeDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| attributeDecl</H3>
|
| <PRE>
|
| public void <B>attributeDecl</B>(java.lang.String eName, |
| java.lang.String aName, |
| java.lang.String type, |
| java.lang.String valueDefault, |
| java.lang.String value) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report an attribute type declaration. |
| |
| <p>Only the effective (first) declaration for an attribute will |
| be reported. The type will be one of the strings "CDATA", |
| "ID", "IDREF", "IDREFS", "NMTOKEN", "NMTOKENS", "ENTITY", |
| "ENTITIES", or "NOTATION", or a parenthesized token group with |
| the separator "|" and all whitespace removed.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>eName</CODE> - The name of the associated element.<DD><CODE>aName</CODE> - The name of the attribute.<DD><CODE>type</CODE> - A string representing the attribute type.<DD><CODE>valueDefault</CODE> - A string representing the attribute default |
| ("#IMPLIED", "#REQUIRED", or "#FIXED") or null if |
| none of these applies.<DD><CODE>value</CODE> - A string representing the attribute's default value, |
| or null if there is none.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getWriter()"><!-- --></A><H3>
|
| getWriter</H3>
|
| <PRE>
|
| public java.io.Writer <B>getWriter</B>()</PRE>
|
| <DL>
|
| <DD>Get the character stream where the events will be serialized to.<DD><DL>
|
| <DT><B>Returns:</B><DD>Reference to the result Writer, or null.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| externalEntityDecl</H3>
|
| <PRE>
|
| public void <B>externalEntityDecl</B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report a parsed external entity declaration. |
| |
| <p>Only the effective (first) declaration for each entity |
| will be reported.</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the entity. If it is a parameter |
| entity, the name will begin with '%'.<DD><CODE>publicId</CODE> - The declared public identifier of the entity, or |
| null if none was declared.<DD><CODE>systemId</CODE> - The declared system identifier of the entity.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#internalEntityDecl(java.lang.String, java.lang.String)"><CODE>internalEntityDecl(java.lang.String, java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/DTDHandler.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><CODE>DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endNonEscaping()"><!-- --></A><H3>
|
| endNonEscaping</H3>
|
| <PRE>
|
| public void <B>endNonEscaping</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Ends an un-escaping section.<DD><DL>
|
| <DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startNonEscaping()"><CODE>startNonEscaping()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startNonEscaping()"><!-- --></A><H3>
|
| startNonEscaping</H3>
|
| <PRE>
|
| public void <B>startNonEscaping</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Starts an un-escaping section. All characters printed within an un- |
| escaping section are printed as is, without escaping special characters |
| into entity references. Only XML and HTML serializers need to support |
| this method. |
| <p> The contents of the un-escaping section will be delivered through the |
| regular <tt>characters</tt> event.<DD><DL>
|
| <DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="characters(char[], int, int)"><!-- --></A><H3>
|
| characters</H3>
|
| <PRE>
|
| public void <B>characters</B>(char[] chars, |
| int start, |
| int length) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of character data. |
| |
| <p>The Parser will call this method to report each chunk of |
| character data. SAX parsers may return all contiguous character |
| data in a single chunk, or they may split it into several |
| chunks; however, all of the characters in any single event |
| must come from the same external entity, so that the Locator |
| provides useful information.</p> |
| |
| <p>The application must not attempt to read from the array |
| outside of the specified range.</p> |
| |
| <p>Note that some parsers will report whitespace using the |
| ignorableWhitespace() method rather than this one (validating |
| parsers must do so).</p><DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>chars</CODE> - The characters from the XML document.<DD><CODE>start</CODE> - The start position in the array.<DD><CODE>length</CODE> - The number of characters to read from the array.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#ignorableWhitespace(char[], int, int)"><CODE>ignorableWhitespace(char[], int, int)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/Locator.html"><CODE>Locator</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="characters(java.lang.String)"><!-- --></A><H3>
|
| characters</H3>
|
| <PRE>
|
| public void <B>characters</B>(java.lang.String s) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of character data.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>s</CODE> - The string of characters to process.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><!-- --></A><H3>
|
| startElement</H3>
|
| <PRE>
|
| public void <B>startElement</B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String name, |
| <A HREF="../../../../org/xml/sax/Attributes.html">Attributes</A> atts) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of the beginning of an element, although this is a |
| SAX method additional namespace or attribute information can occur before |
| or after this call, that is associated with this element.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>namespaceURI</CODE> - The Namespace URI, or the empty string if the |
| element has no Namespace URI or if Namespace |
| processing is not being performed.<DD><CODE>localName</CODE> - The local name (without prefix), or the |
| empty string if Namespace processing is not being |
| performed.<DD><CODE>name</CODE> - The element type name.<DD><CODE>atts</CODE> - The attributes attached to the element, if any.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/ContentHandler.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><CODE>ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/ContentHandler.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><CODE>ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/AttributeList.html"><CODE>AttributeList</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startElement(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| startElement</H3>
|
| <PRE>
|
| public void <B>startElement</B>(java.lang.String elementNamespaceURI, |
| java.lang.String elementLocalName, |
| java.lang.String elementName) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of the beginning of an element, additional |
| namespace or attribute information can occur before or after this call, |
| that is associated with this element.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>elementNamespaceURI</CODE> - The Namespace URI, or the empty string if the |
| element has no Namespace URI or if Namespace |
| processing is not being performed.<DD><CODE>elementLocalName</CODE> - The local name (without prefix), or the |
| empty string if Namespace processing is not being |
| performed.<DD><CODE>elementName</CODE> - The element type name.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/ContentHandler.html#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)"><CODE>ContentHandler.startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/ContentHandler.html#endElement(java.lang.String, java.lang.String, java.lang.String)"><CODE>ContentHandler.endElement(java.lang.String, java.lang.String, java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/AttributeList.html"><CODE>AttributeList</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startElement(java.lang.String)"><!-- --></A><H3>
|
| startElement</H3>
|
| <PRE>
|
| public void <B>startElement</B>(java.lang.String elementName) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="processAttributes(java.io.Writer, int)"><!-- --></A><H3>
|
| processAttributes</H3>
|
| <PRE>
|
| public void <B>processAttributes</B>(java.io.Writer writer, |
| int nAttrs) |
| throws java.io.IOException, |
| <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Process the attributes, which means to write out the currently |
| collected attributes to the writer. The attributes are not |
| cleared by this method<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>writer</CODE> - the writer to write processed attributes to.<DD><CODE>nAttrs</CODE> - the number of attributes in m_attributes |
| to be processed<DT><B>Throws:</B><DD>java.io.IOException - <DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="writeAttrString(java.io.Writer, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| writeAttrString</H3>
|
| <PRE>
|
| public void <B>writeAttrString</B>(java.io.Writer writer, |
| java.lang.String string, |
| java.lang.String encoding) |
| throws java.io.IOException</PRE>
|
| <DL>
|
| <DD>Returns the specified <var>string</var> after substituting <VAR>specials</VAR>, |
| and UTF-16 surrogates for chracter references <CODE>&#xnn</CODE>.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>string</CODE> - String to convert to XML format.<DD><CODE>encoding</CODE> - CURRENTLY NOT IMPLEMENTED.<DT><B>Throws:</B><DD>java.io.IOException - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endElement(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| endElement</H3>
|
| <PRE>
|
| public void <B>endElement</B>(java.lang.String namespaceURI, |
| java.lang.String localName, |
| java.lang.String name) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of the end of an element.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>namespaceURI</CODE> - The Namespace URI, or the empty string if the |
| element has no Namespace URI or if Namespace |
| processing is not being performed.<DD><CODE>localName</CODE> - The local name (without prefix), or the |
| empty string if Namespace processing is not being |
| performed.<DD><CODE>name</CODE> - The element type name<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - </DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endElement(java.lang.String)"><!-- --></A><H3>
|
| endElement</H3>
|
| <PRE>
|
| public void <B>endElement</B>(java.lang.String name) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of the end of an element.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The element type name<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startPrefixMapping(java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| startPrefixMapping</H3>
|
| <PRE>
|
| public void <B>startPrefixMapping</B>(java.lang.String prefix, |
| java.lang.String uri) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Begin the scope of a prefix-URI Namespace mapping |
| just before another element is about to start. |
| This call will close any open tags so that the prefix mapping |
| will not apply to the current element, but the up comming child.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The Namespace prefix being declared.<DD><CODE>uri</CODE> - The Namespace URI the prefix is mapped to.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The client may throw |
| an exception during processing.<DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/ContentHandler.html#startPrefixMapping(java.lang.String, java.lang.String)"><CODE>ContentHandler.startPrefixMapping(java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startPrefixMapping(java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
|
| startPrefixMapping</H3>
|
| <PRE>
|
| public boolean <B>startPrefixMapping</B>(java.lang.String prefix, |
| java.lang.String uri, |
| boolean shouldFlush) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Handle a prefix/uri mapping, which is associated with a startElement() |
| that is soon to follow. Need to close any open start tag to make |
| sure than any name space attributes due to this event are associated wih |
| the up comming element, not the current one.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The Namespace prefix being declared.<DD><CODE>uri</CODE> - The Namespace URI the prefix is mapped to.<DD><CODE>shouldFlush</CODE> - true if any open tags need to be closed first, this |
| will impact which element the mapping applies to (open parent, or its up |
| comming child)<DT><B>Returns:</B><DD>returns true if the call made a change to the current |
| namespace information, false if it did not change anything, e.g. if the |
| prefix/namespace mapping was already in scope from before.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The client may throw |
| an exception during processing.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ExtendedContentHandler.html#startPrefixMapping(java.lang.String, java.lang.String, boolean)"><CODE>ExtendedContentHandler.startPrefixMapping(java.lang.String, java.lang.String, boolean)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="comment(char[], int, int)"><!-- --></A><H3>
|
| comment</H3>
|
| <PRE>
|
| public void <B>comment</B>(char[] ch, |
| int start, |
| int length) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of an XML comment anywhere in the document. This |
| callback will be used for comments inside or outside the document |
| element, including comments in the external DTD subset (if read).<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>ch</CODE> - An array holding the characters in the comment.<DD><CODE>start</CODE> - The starting position in the array.<DD><CODE>length</CODE> - The number of characters to use from the array.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endCDATA()"><!-- --></A><H3>
|
| endCDATA</H3>
|
| <PRE>
|
| public void <B>endCDATA</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report the end of a CDATA section.<DD><DL>
|
| <DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startCDATA()"><CODE>startCDATA()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endDTD()"><!-- --></A><H3>
|
| endDTD</H3>
|
| <PRE>
|
| public void <B>endDTD</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report the end of DTD declarations.<DD><DL>
|
| <DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#startDTD(java.lang.String, java.lang.String, java.lang.String)"><CODE>startDTD(java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="endPrefixMapping(java.lang.String)"><!-- --></A><H3>
|
| endPrefixMapping</H3>
|
| <PRE>
|
| public void <B>endPrefixMapping</B>(java.lang.String prefix) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>End the scope of a prefix-URI Namespace mapping.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>prefix</CODE> - The prefix that was being mapping.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The client may throw |
| an exception during processing.<DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/ContentHandler.html#endPrefixMapping(java.lang.String)"><CODE>ContentHandler.endPrefixMapping(java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="ignorableWhitespace(char[], int, int)"><!-- --></A><H3>
|
| ignorableWhitespace</H3>
|
| <PRE>
|
| public void <B>ignorableWhitespace</B>(char[] ch, |
| int start, |
| int length) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of ignorable whitespace in element content. |
| |
| Not sure how to get this invoked quite yet.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>ch</CODE> - The characters from the XML document.<DD><CODE>start</CODE> - The start position in the array.<DD><CODE>length</CODE> - The number of characters to read from the array.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly |
| wrapping another exception.<DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - <DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#characters(char[], int, int)"><CODE>characters(char[], int, int)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="skippedEntity(java.lang.String)"><!-- --></A><H3>
|
| skippedEntity</H3>
|
| <PRE>
|
| public void <B>skippedEntity</B>(java.lang.String name) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Receive notification of a skipped entity.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the skipped entity. If it is a |
| parameter entity, the name will begin with '%', |
| and if it is the external DTD subset, it will be the string |
| "[dtd]".<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - Any SAX exception, possibly wrapping |
| another exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/ContentHandler.html#skippedEntity(java.lang.String)"><CODE>ContentHandler.skippedEntity(java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startCDATA()"><!-- --></A><H3>
|
| startCDATA</H3>
|
| <PRE>
|
| public void <B>startCDATA</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report the start of a CDATA section.<DD><DL>
|
| <DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endCDATA()"><CODE>endCDATA()</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startEntity(java.lang.String)"><!-- --></A><H3>
|
| startEntity</H3>
|
| <PRE>
|
| public void <B>startEntity</B>(java.lang.String name) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report the beginning of an entity. |
| |
| The start and end of the document entity are not reported. |
| The start and end of the external DTD subset are reported |
| using the pseudo-name "[dtd]". All other events must be |
| properly nested within start/end entity events.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the entity. If it is a parameter |
| entity, the name will begin with '%'.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#endEntity(java.lang.String)"><CODE>SerializerBase.endEntity(java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/ext/DeclHandler.html#internalEntityDecl(java.lang.String, java.lang.String)"><CODE>DeclHandler.internalEntityDecl(java.lang.String, java.lang.String)</CODE></A>,
|
| <A HREF="../../../../org/xml/sax/ext/DeclHandler.html#externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)"><CODE>DeclHandler.externalEntityDecl(java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="startDTD(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| startDTD</H3>
|
| <PRE>
|
| public void <B>startDTD</B>(java.lang.String name, |
| java.lang.String publicId, |
| java.lang.String systemId) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>Report the start of DTD declarations, if any. |
| |
| Any declarations are assumed to be in the internal subset unless |
| otherwise indicated.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>name</CODE> - The document type name.<DD><CODE>publicId</CODE> - The declared public identifier for the |
| external DTD subset, or null if none was declared.<DD><CODE>systemId</CODE> - The declared system identifier for the |
| external DTD subset, or null if none was declared.<DT><B>Throws:</B><DD><A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A> - The application may raise an |
| exception.<DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/ToStream.html#endDTD()"><CODE>endDTD()</CODE></A>,
|
| <A HREF="../../../../org/apache/xml/serializer/ToStream.html#startEntity(java.lang.String)"><CODE>startEntity(java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="getIndentAmount()"><!-- --></A><H3>
|
| getIndentAmount</H3>
|
| <PRE>
|
| public int <B>getIndentAmount</B>()</PRE>
|
| <DL>
|
| <DD>Returns the m_indentAmount.<DD><DL>
|
| <DT><B>Returns:</B><DD>int<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#getIndentAmount()">getIndentAmount</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setIndentAmount(int)"><!-- --></A><H3>
|
| setIndentAmount</H3>
|
| <PRE>
|
| public void <B>setIndentAmount</B>(int m_indentAmount)</PRE>
|
| <DL>
|
| <DD>Sets the m_indentAmount.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>m_indentAmount</CODE> - The m_indentAmount to set<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setIndentAmount(int)">setIndentAmount</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setCdataSectionElements(java.util.Vector)"><!-- --></A><H3>
|
| setCdataSectionElements</H3>
|
| <PRE>
|
| public void <B>setCdataSectionElements</B>(java.util.Vector URI_and_localNames)</PRE>
|
| <DL>
|
| <DD>Remembers the cdata sections specified in the cdata-section-elements. |
| The "official way to set URI and localName pairs. |
| This method should be used by both Xalan and XSLTC.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>URI_and_localNames</CODE> - a vector of pairs of Strings (URI/local)</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="flushPending()"><!-- --></A><H3>
|
| flushPending</H3>
|
| <PRE>
|
| public void <B>flushPending</B>() |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>This method flushes any pending events, which can be startDocument() |
| closing the opening tag of an element, or closing an open CDATA section.</DL>
|
| <HR>
|
|
|
| <A NAME="setContentHandler(org.xml.sax.ContentHandler)"><!-- --></A><H3>
|
| setContentHandler</H3>
|
| <PRE>
|
| public void <B>setContentHandler</B>(<A HREF="../../../../org/xml/sax/ContentHandler.html">ContentHandler</A> ch)</PRE>
|
| <DL>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addAttributeAlways(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)"><!-- --></A><H3>
|
| addAttributeAlways</H3>
|
| <PRE>
|
| public boolean <B>addAttributeAlways</B>(java.lang.String uri, |
| java.lang.String localName, |
| java.lang.String rawName, |
| java.lang.String type, |
| java.lang.String value, |
| boolean xslAttribute)</PRE>
|
| <DL>
|
| <DD>Adds the given attribute to the set of attributes, even if there is |
| no currently open element. This is useful if a SAX startPrefixMapping() |
| should need to add an attribute before the element name is seen. |
| |
| This method is a copy of its super classes method, except that some |
| tracing of events is done. This is so the tracing is only done for |
| stream serializers, not for SAX ones.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - the URI of the attribute<DD><CODE>localName</CODE> - the local name of the attribute<DD><CODE>rawName</CODE> - the qualified name of the attribute<DD><CODE>type</CODE> - the type of the attribute (probably CDATA)<DD><CODE>value</CODE> - the value of the attribute<DD><CODE>xslAttribute</CODE> - true if this attribute is coming from an xsl:attribute element.<DT><B>Returns:</B><DD>true if the attribute value was added, |
| false if the attribute already existed and the value was |
| replaced with the new value.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#addAttributeAlways(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean)">addAttributeAlways</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setTransformer(javax.xml.transform.Transformer)"><!-- --></A><H3>
|
| setTransformer</H3>
|
| <PRE>
|
| public void <B>setTransformer</B>(<A HREF="../../../../javax/xml/transform/Transformer.html">Transformer</A> transformer)</PRE>
|
| <DL>
|
| <DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setTransformer(javax.xml.transform.Transformer)">setTransformer</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A><DT><B>See Also: </B><DD><A HREF="../../../../org/apache/xml/serializer/SerializationHandler.html#setTransformer(javax.xml.transform.Transformer)"><CODE>SerializationHandler.setTransformer(Transformer)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="reset()"><!-- --></A><H3>
|
| reset</H3>
|
| <PRE>
|
| public boolean <B>reset</B>()</PRE>
|
| <DL>
|
| <DD>Try's to reset the super class and reset this class for |
| re-use, so that you don't need to create a new serializer |
| (mostly for performance reasons).<DD><DL>
|
| <DT><B>Returns:</B><DD>true if the class was successfuly reset.<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#reset()">reset</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setEncoding(java.lang.String)"><!-- --></A><H3>
|
| setEncoding</H3>
|
| <PRE>
|
| public void <B>setEncoding</B>(java.lang.String encoding)</PRE>
|
| <DL>
|
| <DD>Sets the character encoding coming from the xsl:output encoding stylesheet attribute.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>encoding</CODE> - the character encoding<DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setEncoding(java.lang.String)">setEncoding</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="notationDecl(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| notationDecl</H3>
|
| <PRE>
|
| public void <B>notationDecl</B>(java.lang.String name, |
| java.lang.String pubID, |
| java.lang.String sysID) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>If this method is called, the serializer is used as a |
| DTDHandler, which changes behavior how the serializer |
| handles document entities.<DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#notationDecl(java.lang.String, java.lang.String, java.lang.String)">notationDecl</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A><DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/DTDHandler.html#notationDecl(java.lang.String, java.lang.String, java.lang.String)"><CODE>DTDHandler.notationDecl(java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3>
|
| unparsedEntityDecl</H3>
|
| <PRE>
|
| public void <B>unparsedEntityDecl</B>(java.lang.String name, |
| java.lang.String pubID, |
| java.lang.String sysID, |
| java.lang.String notationName) |
| throws <A HREF="../../../../org/xml/sax/SAXException.html">SAXException</A></PRE>
|
| <DL>
|
| <DD>If this method is called, the serializer is used as a |
| DTDHandler, which changes behavior how the serializer |
| handles document entities.<DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">unparsedEntityDecl</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A><DT><B>See Also: </B><DD><A HREF="../../../../org/xml/sax/DTDHandler.html#unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><CODE>DTDHandler.unparsedEntityDecl(java.lang.String, java.lang.String, java.lang.String, java.lang.String)</CODE></A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setDTDEntityExpansion(boolean)"><!-- --></A><H3>
|
| setDTDEntityExpansion</H3>
|
| <PRE>
|
| public void <B>setDTDEntityExpansion</B>(boolean expand)</PRE>
|
| <DL>
|
| <DD>If set to false the serializer does not expand DTD entities, |
| but leaves them as is, the default value is true;<DD><DL>
|
| <DT><B>Overrides:</B><DD><A HREF="../../../../org/apache/xml/serializer/SerializerBase.html#setDTDEntityExpansion(boolean)">setDTDEntityExpansion</A> in class <A HREF="../../../../org/apache/xml/serializer/SerializerBase.html">SerializerBase</A></DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="setNewLine(char[])"><!-- --></A><H3>
|
| setNewLine</H3>
|
| <PRE>
|
| public void <B>setNewLine</B>(char[] eolChars)</PRE>
|
| <DL>
|
| <DD>Sets the end of line characters to be used during serialization<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>eolChars</CODE> - A character array corresponding to the characters to be used.</DL>
|
| </DD>
|
| </DL>
|
| <HR>
|
|
|
| <A NAME="addCdataSectionElements(java.lang.String)"><!-- --></A><H3>
|
| addCdataSectionElements</H3>
|
| <PRE>
|
| public void <B>addCdataSectionElements</B>(java.lang.String URI_and_localNames)</PRE>
|
| <DL>
|
| <DD>Remembers the cdata sections specified in the cdata-section-elements by appending the given |
| cdata section elements to the list. This method can be called multiple times, but once an |
| element is put in the list of cdata section elements it can not be removed. |
| This method should be used by both Xalan and XSLTC.<DD><DL>
|
| <DT><B>Parameters:</B><DD><CODE>URI_and_localNames</CODE> - a whitespace separated list of element names, each element |
| is a URI in curly braces (optional) and a local name. An example of such a parameter is: |
| "{http://company.com}price {myURI2}book chapter"</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> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
|
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/ToStream.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
|
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
|
| </TR>
|
| </TABLE>
|
| </TD>
|
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
|
| </EM>
|
| </TD>
|
| </TR>
|
|
|
| <TR>
|
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
| <A HREF="../../../../org/apache/xml/serializer/ToSAXHandler.html"><B>PREV CLASS</B></A>
|
| <A HREF="../../../../org/apache/xml/serializer/ToTextSAXHandler.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>
|
| <A HREF="ToStream.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
|
| </TR>
|
| <TR>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| SUMMARY: INNER | <A HREF="#fields_inherited_from_class_org.apache.xml.serializer.SerializerBase">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
| </TR>
|
| </TABLE>
|
| <!-- =========== END OF NAVBAR =========== -->
|
|
|
| <HR>
|
| Copyright © 2006 Apache XML Project. All Rights Reserved.
|
| </BODY>
|
| </HTML>
|