blob: 6c4d56236ad0bf7ba6f769c2f44e3b6ff33116c5 [file] [log] [blame]
<HTML><HEAD><TITLE>Xalan-C++ API Documentation</TITLE></HEAD>
<BODY>
<h2 align="center">Xalan-C++ API Documentation</h2>
<h3 align="center">The Xalan C++ XSLT Processor Version 1.10</h3>
</BODY>
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; </center>
<hr><h1>XalanOutputStream Class Reference</h1><code>#include &lt;<a class="el" href="XalanOutputStream_8hpp-source.html">XalanOutputStream.hpp</a>&gt;</code>
<p>
Inheritance diagram for XalanOutputStream:<p><center><img src="classXalanOutputStream__inherit__graph.gif" border="0" usemap="#XalanOutputStream_inherit_map" alt="Inheritance graph"></center>
<map name="XalanOutputStream_inherit_map">
<area href="classXalanFileOutputStream.html" shape="rect" coords="224,31,378,7">
<area href="classXalanFStreamOutputStream.html" shape="rect" coords="209,79,393,55">
<area href="classXalanNullOutputStream.html" shape="rect" coords="224,126,378,103">
<area href="classXalanStdOutputStream.html" shape="rect" coords="225,174,377,150">
<area href="classXalanTransformerOutputStream.html" shape="rect" coords="199,222,404,198">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for XalanOutputStream:<p><center><img src="classXalanOutputStream__coll__graph.gif" border="0" usemap="#XalanOutputStream_coll_map" alt="Collaboration graph"></center>
<map name="XalanOutputStream_coll_map">
<area href="classXalanDOMString.html" shape="rect" coords="6,42,124,18">
<area href="classXalanOutputTranscoder.html" shape="rect" coords="148,42,305,18">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classXalanOutputStream-members.html">List of all members.</a><h2>Public Types</h2>
<ul>
<li>typedef XalanVector&lt;XalanDOMChar&gt; <a class="el" href="classXalanOutputStream.html#s0">BufferType</a>
<li>typedef XalanVector&lt;char&gt; <a class="el" href="classXalanOutputStream.html#s1">TranscodeVectorType</a>
<li>typedef XalanTranscodingServices::size_type <a class="el" href="classXalanOutputStream.html#s2">size_type</a>
<li>typedef XalanTranscodingServices::UnicodeCharType <a class="el" href="classXalanOutputStream.html#s3">UnicodeCharType</a>
<li>enum { <a class="el" href="classXalanOutputStream.html#s6s4">eDefaultBufferSize</a> = 512u,
<a class="el" href="classXalanOutputStream.html#s6s5">eDefaultTranscoderBlockSize</a> = 1024u
}
</ul>
<h2>Public Methods</h2>
<ul>
<li><a class="el" href="classXalanOutputStream.html#a0">XalanOutputStream</a> (<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp;theManager, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferSize=eDefaultBufferSize, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theTranscoderBlockSize=eDefaultTranscoderBlockSize, bool fThrowTranscodeException=true)
<dl class="el"><dd><font size=-1><em>Constructor.</em> <a href="#a0">More...</a><em><br><br></em></font></dl><li>virtual <a class="el" href="classXalanOutputStream.html#a1">~XalanOutputStream</a> ()
<li><a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a>&amp; <a class="el" href="classXalanOutputStream.html#a2">getMemoryManager</a> ()
<li>virtual void <a class="el" href="classXalanOutputStream.html#a3">newline</a> ()
<dl class="el"><dd><font size=-1><em>Write the appropriate newline character(s) to the stream.</em> <a href="#a3">More...</a><em><br><br></em></font></dl><li>virtual const XalanDOMChar* <a class="el" href="classXalanOutputStream.html#a4">getNewlineString</a> () const
<dl class="el"><dd><font size=-1><em>Get the string which is appropriate for inserting a line feed in the stream.</em> <a href="#a4">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a5">flushBuffer</a> ()
<dl class="el"><dd><font size=-1><em>Flush the stream's transcoding buffer, but do not request the implementation class to flush its buffer.</em> <a href="#a5">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a6">flush</a> ()
<dl class="el"><dd><font size=-1><em>Flush the stream's buffer.</em> <a href="#a6">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a7">write</a> (char theChar)
<dl class="el"><dd><font size=-1><em>Write a character to the output stream.</em> <a href="#a7">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a8">write</a> (XalanDOMChar theChar)
<dl class="el"><dd><font size=-1><em>Write a wide character to the output stream.</em> <a href="#a8">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a9">write</a> (const char *theBuffer)
<dl class="el"><dd><font size=-1><em>Write a null-terminated string to the output file.</em> <a href="#a9">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a10">write</a> (const XalanDOMChar *theBuffer)
<dl class="el"><dd><font size=-1><em>Write a null-terminated wide string to the output file.</em> <a href="#a10">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a11">write</a> (const char *theBuffer, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferLength)
<dl class="el"><dd><font size=-1><em>Write a specified number of characters to the output stream.</em> <a href="#a11">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a12">write</a> (const XalanDOMChar *theBuffer, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferLength)
<dl class="el"><dd><font size=-1><em>Write a specified number of characters to the output stream.</em> <a href="#a12">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanDOMString.html">XalanDOMString</a>&amp; <a class="el" href="classXalanOutputStream.html#a13">getOutputEncoding</a> () const
<dl class="el"><dd><font size=-1><em>Get the output encoding for the stream.</em> <a href="#a13">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a14">setOutputEncoding</a> (const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp;theEncoding)
<dl class="el"><dd><font size=-1><em>Set the output encoding for the stream.</em> <a href="#a14">More...</a><em><br><br></em></font></dl><li>bool <a class="el" href="classXalanOutputStream.html#a15">canTranscodeTo</a> (<a class="el" href="classXalanOutputStream.html#s3">UnicodeCharType</a> theChar) const
<dl class="el"><dd><font size=-1><em>Determine if a given value can be represented in the output encoding.</em> <a href="#a15">More...</a><em><br><br></em></font></dl><li>const <a class="el" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a>* <a class="el" href="classXalanOutputStream.html#a16">getTranscoder</a> () const
<li>bool <a class="el" href="classXalanOutputStream.html#a17">getThrowTranscodeException</a> () const
<dl class="el"><dd><font size=-1><em>Set the flag that indicates whether a transcoding error should throw an exception.</em> <a href="#a17">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a18">setThrowTranscodeException</a> (bool flag)
<dl class="el"><dd><font size=-1><em>Set the flag that indicates whether a transcoding error should throw an exception.</em> <a href="#a18">More...</a><em><br><br></em></font></dl><li>void <a class="el" href="classXalanOutputStream.html#a19">setBufferSize</a> (<a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferSize)
<dl class="el"><dd><font size=-1><em>Set the size of the output buffer.</em> <a href="#a19">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Public Methods</h2>
<ul>
<li>const XalanDOMChar* <a class="el" href="classXalanOutputStream.html#d0">defaultNewlineString</a> ()
</ul>
<h2>Protected Methods</h2>
<ul>
<li>void <a class="el" href="classXalanOutputStream.html#b0">transcode</a> (const XalanDOMChar *theBuffer, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferLength, <a class="el" href="classXalanOutputStream.html#s1">TranscodeVectorType</a> &amp;theDestination)
<dl class="el"><dd><font size=-1><em>Transcode a wide string.</em> <a href="#b0">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXalanOutputStream.html#b1">writeData</a> (const char *theBuffer, <a class="el" href="classXalanOutputStream.html#s2">size_type</a> theBufferLength)=0
<dl class="el"><dd><font size=-1><em>Write the data in the buffer.</em> <a href="#b1">More...</a><em><br><br></em></font></dl><li>virtual void <a class="el" href="classXalanOutputStream.html#b2">doFlush</a> ()=0
<dl class="el"><dd><font size=-1><em>Flush the stream.</em> <a href="#b2">More...</a><em><br><br></em></font></dl></ul>
<h2>Static Protected Attributes</h2>
<ul>
<li>const XalanDOMChar <a class="el" href="classXalanOutputStream.html#q0">s_nlString</a> []
<li>const XalanDOMChar <a class="el" href="classXalanOutputStream.html#q1">s_nlCRString</a> []
<li>const <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <a class="el" href="classXalanOutputStream.html#q2">s_nlStringLength</a>
<li>const <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> <a class="el" href="classXalanOutputStream.html#q3">s_nlCRStringLength</a>
</ul>
<hr><h2>Member Typedef Documentation</h2>
<a name="s0" doxytag="XalanOutputStream::BufferType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XalanVector&lt; XalanDOMChar &gt; XalanOutputStream::BufferType&lt;XalanDOMChar&gt;
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="s1" doxytag="XalanOutputStream::TranscodeVectorType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XalanVector&lt; char &gt; XalanOutputStream::TranscodeVectorType&lt;char&gt;
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="s3" doxytag="XalanOutputStream::UnicodeCharType"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XalanTranscodingServices::UnicodeCharType XalanOutputStream::UnicodeCharType
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="s2" doxytag="XalanOutputStream::size_type"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
typedef XalanTranscodingServices::size_type XalanOutputStream::size_type
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Enumeration Documentation</h2>
<a name="s6" doxytag="XalanOutputStream::@14"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
anonymous enum
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
<dl compact><dt>
<b>Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><a name="s6s4" doxytag="eDefaultBufferSize"></a><em>eDefaultBufferSize</em>
&nbsp;</td><td>
</td></tr>
<tr><td valign=top><a name="s6s5" doxytag="eDefaultTranscoderBlockSize"></a><em>eDefaultTranscoderBlockSize</em>
&nbsp;</td><td>
</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a name="a0" doxytag="XalanOutputStream::XalanOutputStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanOutputStream::XalanOutputStream (
</b></td>
<td valign="bottom"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; <em>theManager</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferSize</em> = eDefaultBufferSize,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theTranscoderBlockSize</em> = eDefaultTranscoderBlockSize,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
bool <em>fThrowTranscodeException</em> = true&nbsp;)<code> [explicit]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Constructor.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBufferSize</em>
&nbsp;</td><td>
the size of the transcoding buffer </td></tr>
<tr><td valign=top><em>theTranscoderBlockSize</em>
&nbsp;</td><td>
the size of the block used by the transcoder </td></tr>
<tr><td valign=top><em>fThrowTranscodeException</em>
&nbsp;</td><td>
If true, an error transcoding will result in an exception being thrown. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a1" doxytag="XalanOutputStream::~XalanOutputStream"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
XalanOutputStream::~XalanOutputStream (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="a15" doxytag="XalanOutputStream::canTranscodeTo"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XalanOutputStream::canTranscodeTo (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanOutputStream.html#s3">UnicodeCharType</a> <em>theChar</em>&nbsp;) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Determine if a given value can be represented in the output encoding.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if the value can be represented, and false if not. </dl> </td>
</tr>
</table>
<a name="d0" doxytag="XalanOutputStream::defaultNewlineString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const XalanDOMChar * XalanOutputStream::defaultNewlineString (
</b></td>
<td valign="bottom"><b>
)<code> [static]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="b2" doxytag="XalanOutputStream::doFlush"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::doFlush (
</b></td>
<td valign="bottom"><b>
)<code> [protected, pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the stream.
<p>
<p>
Reimplemented in <a class="el" href="classXalanFileOutputStream.html#b1">XalanFileOutputStream</a>, <a class="el" href="classXalanFStreamOutputStream.html#b1">XalanFStreamOutputStream</a>, <a class="el" href="classXalanNullOutputStream.html#b1">XalanNullOutputStream</a>, <a class="el" href="classXalanStdOutputStream.html#b1">XalanStdOutputStream</a>, and <a class="el" href="classXalanTransformerOutputStream.html#b1">XalanTransformerOutputStream</a>. </td>
</tr>
</table>
<a name="a6" doxytag="XalanOutputStream::flush"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::flush (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the stream's buffer.
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="XalanOutputStream::flushBuffer"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::flushBuffer (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Flush the stream's transcoding buffer, but do not request the implementation class to flush its buffer.
<p>
. </td>
</tr>
</table>
<a name="a2" doxytag="XalanOutputStream::getMemoryManager"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
<a class="el" href="XalanMemoryManagement_8hpp.html#a5">MemoryManagerType</a> &amp; XalanOutputStream::getMemoryManager (
</b></td>
<td valign="bottom"><b>
)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a4" doxytag="XalanOutputStream::getNewlineString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const XalanDOMChar * XalanOutputStream::getNewlineString (
</b></td>
<td valign="bottom"><b>
) const<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the string which is appropriate for inserting a line feed in the stream.
<p>
</td>
</tr>
</table>
<a name="a13" doxytag="XalanOutputStream::getOutputEncoding"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; XalanOutputStream::getOutputEncoding (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get the output encoding for the stream.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
The encoding name </dl> </td>
</tr>
</table>
<a name="a17" doxytag="XalanOutputStream::getThrowTranscodeException"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
bool XalanOutputStream::getThrowTranscodeException (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the flag that indicates whether a transcoding error should throw an exception.
<p>
The default is to throw an exception. If this flag is false, and and an error occurs transcoding, then data will likely be lost.
<p>
<dl compact><dt>
<b>Returns: </b><dd>
the value of the flag. </dl> </td>
</tr>
</table>
<a name="a16" doxytag="XalanOutputStream::getTranscoder"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanOutputTranscoder.html">XalanOutputTranscoder</a> * XalanOutputStream::getTranscoder (
</b></td>
<td valign="bottom"><b>
) const
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="XalanOutputStream::newline"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::newline (
</b></td>
<td valign="bottom"><b>
)<code> [virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write the appropriate newline character(s) to the stream.
<p>
</td>
</tr>
</table>
<a name="a19" doxytag="XalanOutputStream::setBufferSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::setBufferSize (
</b></td>
<td valign="bottom"><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferSize</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the size of the output buffer.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBufferSize</em>
&nbsp;</td><td>
The buffer size. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a14" doxytag="XalanOutputStream::setOutputEncoding"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::setOutputEncoding (
</b></td>
<td valign="bottom"><b>
const <a class="el" href="classXalanDOMString.html">XalanDOMString</a> &amp; <em>theEncoding</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the output encoding for the stream.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theEncoding</em>
&nbsp;</td><td>
The encoding name </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a18" doxytag="XalanOutputStream::setThrowTranscodeException"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::setThrowTranscodeException (
</b></td>
<td valign="bottom"><b>
bool <em>flag</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set the flag that indicates whether a transcoding error should throw an exception.
<p>
The default is to throw an exception. If this flag is false, and and an error occurs transcoding, then data will likely be lost.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>the</em>
&nbsp;</td><td>
new value of the flag. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b0" doxytag="XalanOutputStream::transcode"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::transcode (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theBuffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferLength</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s1">TranscodeVectorType</a> &amp; <em>theDestination</em>&nbsp;)<code> [protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Transcode a wide string.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
The string to transcode. </td></tr>
<tr><td valign=top><em>theBufferLength</em>
&nbsp;</td><td>
The length of the string. </td></tr>
<tr><td valign=top><em>theDestination</em>
&nbsp;</td><td>
The destination vector. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a12" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theBuffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferLength</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a specified number of characters to the output stream.
<p>
The string will be transcoded, if an output encoding is specified.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
character buffer to write </td></tr>
<tr><td valign=top><em>theBufferLength</em>
&nbsp;</td><td>
number of characters to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a11" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
const char * <em>theBuffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferLength</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a specified number of characters to the output stream.
<p>
The string will not be transcoded. The caller is responsible for making sure the buffer is flushed before calling this member function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
character buffer to write </td></tr>
<tr><td valign=top><em>theBufferLength</em>
&nbsp;</td><td>
number of characters to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a10" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
const XalanDOMChar * <em>theBuffer</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a null-terminated wide string to the output file.
<p>
The string will be transcoded, if an output encoding is specified.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
character buffer to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a9" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
const char * <em>theBuffer</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a null-terminated string to the output file.
<p>
The character will not be transcoded. The caller is responsible for making sure the buffer is flushed before calling this member function.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
character buffer to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a8" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
XalanDOMChar <em>theChar</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a wide character to the output stream.
<p>
The character will be transcoded, if an output encoding is specified.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theChar</em>
&nbsp;</td><td>
the character to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="XalanOutputStream::write"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::write (
</b></td>
<td valign="bottom"><b>
char <em>theChar</em>&nbsp;)
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write a character to the output stream.
<p>
The character will not be transcoded.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theChar</em>
&nbsp;</td><td>
the character to write </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b1" doxytag="XalanOutputStream::writeData"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void XalanOutputStream::writeData (
</b></td>
<td valign="bottom"><b>
const char * <em>theBuffer</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
<a class="el" href="classXalanOutputStream.html#s2">size_type</a> <em>theBufferLength</em>&nbsp;)<code> [protected, pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Write the data in the buffer.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>theBuffer</em>
&nbsp;</td><td>
The data to write </td></tr>
<tr><td valign=top><em>theBufferLength</em>
&nbsp;</td><td>
The length of theBuffer. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classXalanFileOutputStream.html#b0">XalanFileOutputStream</a>, <a class="el" href="classXalanFStreamOutputStream.html#b0">XalanFStreamOutputStream</a>, <a class="el" href="classXalanNullOutputStream.html#b0">XalanNullOutputStream</a>, <a class="el" href="classXalanStdOutputStream.html#b0">XalanStdOutputStream</a>, and <a class="el" href="classXalanTransformerOutputStream.html#b0">XalanTransformerOutputStream</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="q1" doxytag="XalanOutputStream::s_nlCRString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const XalanDOMChar XalanOutputStream::s_nlCRString<code> [static, protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="q3" doxytag="XalanOutputStream::s_nlCRStringLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> XalanOutputStream::s_nlCRStringLength<code> [static, protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="q0" doxytag="XalanOutputStream::s_nlString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const XalanDOMChar XalanOutputStream::s_nlString<code> [static, protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="q2" doxytag="XalanOutputStream::s_nlStringLength"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
const <a class="el" href="classXalanDOMString.html#s6">XalanDOMString::size_type</a> XalanOutputStream::s_nlStringLength<code> [static, protected]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="XalanOutputStream_8hpp-source.html">XalanOutputStream.hpp</a></ul>
<p align="center"><a href="diagramnotes.html">Interpreting class diagrams</a></p>
<p><FONT color="#000000" face="arial,helvetica,sanserif" size="-1">
<i><A href="http://www.stack.nl/~dimitri/doxygen/">Doxygen</A> and
<A href="http://www.research.att.com/sw/tools/graphviz/">GraphViz</A> are used to generate this API documentation from the Xalan-C header files.</I></FONT></p>
<TABLE border="0" cellpadding="0" cellspacing="0" width="820"><TR><TD bgcolor="#0086b2"><IMG height="1" src="../resources/dot.gif" width="1" alt="dot"></TD></TR></TABLE>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="0" WIDTH="80%">
<TR>
<TD WIDTH="80%" VALIGN="TOP">
<P ALIGN="CENTER"><B>Xalan-C++ XSLT Processor Version 1.10</B><BR>
Copyright &copy; 1999-2004 The Apache Software Foundation. All Rights Reserved.</i></p>
</TD>
</TR>
<TR>
<TD WIDTH="100%">
<P ALIGN="CENTER"><IMG SRC="ApacheLogo.jpg" WIDTH="387" HEIGHT="100" ALIGN="BOTTOM" BORDER="0" ALT="Apache Logo">
</TD>
</TR>
</TABLE>