Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

XalanOutputStream Class Reference

#include <XalanOutputStream.hpp>

Inheritance diagram for XalanOutputStream

Inheritance graph

[legend]
Collaboration diagram for XalanOutputStream:

Collaboration graph

[legend]
List of all members.

Public Types

Public Methods

Protected Methods


Member Typedef Documentation

typedef std::vector<XalanDOMChar> XalanOutputStream::BufferType
 

typedef std::vector<char> XalanOutputStream::TranscodeVectorType
 


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
eDefaultBufferSize  
eDefaultTranscoderBlockSize  


Constructor & Destructor Documentation

XalanOutputStream::XalanOutputStream ( BufferType::size_type theBufferSize = eDefaultBufferSize,
TranscodeVectorType::size_type theTranscoderBlockSize = eDefaultTranscoderBlockSize,
bool fThrowTranscodeException = true ) [explicit]
 

Constructor.

Parameters:
theBufferSize   the size of the transcoding buffer
theTranscoderBlockSize   the size of the block used by the transcoder
fThrowTranscodeException   If true, an error transcoding will result in an exception being thrown.

virtual XalanOutputStream::~XalanOutputStream ( ) [virtual]
 


Member Function Documentation

virtual void XalanOutputStream::doFlush ( ) [protected, pure virtual]
 

Reimplemented in XalanFileOutputStream, XalanNullOutputStream, XalanStdOutputStream, and XalanTransformerOutputStream.

void XalanOutputStream::flush ( ) []
 

Flush the stream's buffer.

const XalanDOMString & XalanOutputStream::getOutputEncoding ( ) const []
 

Get the output encoding for the stream.

Returns:
The encoding name

bool XalanOutputStream::getThrowTranscodeException ( ) const []
 

Set the flag that indicates whether a transcoding error should throw an exception.

The default is to throw an exception. If this flag is false, and and an error occurs transcoding, then data will likely be lost.

Returns:
the value of the flag.

void XalanOutputStream::setBufferSize ( BufferType::size_type theBufferSize )
 

Set the size of the output buffer.

Parameters:
theBufferSize   The buffer size.

void XalanOutputStream::setOutputEncoding ( const XalanDOMString & theEncoding )
 

Set the output encoding for the stream.

Parameters:
theEncoding   The encoding name

void XalanOutputStream::setThrowTranscodeException ( bool flag ) []
 

Set the flag that indicates whether a transcoding error should throw an exception.

The default is to throw an exception. If this flag is false, and and an error occurs transcoding, then data will likely be lost.

Parameters:
the   new value of the flag.

void XalanOutputStream::transcode ( const XalanDOMChar * theBuffer,
unsigned long theBufferLength,
TranscodeVectorType & theDestination ) [protected]
 

Transcode a wide string.

Parameters:
theBuffer   The string to transcode.
theBufferLength   The length of the string.
theDestination   The destination vector.

void XalanOutputStream::write ( const XalanDOMChar * theBuffer,
unsigned long theBufferLength )
 

Write a specified number of characters to the output stream.

The string will be transcoded, if an output encoding is specified.

Parameters:
theBuffer   character buffer to write
theBufferLength   number of characters to write

void XalanOutputStream::write ( const char * theBuffer,
unsigned long theBufferLength ) []
 

Write a specified number of characters to the output stream.

The string will not be transcoded.

Parameters:
theBuffer   character buffer to write
theBufferLength   number of characters to write

void XalanOutputStream::write ( const XalanDOMChar * theBuffer ) []
 

Write a null-terminated wide string to the output file.

The string will be transcoded, if an output encoding is specified.

Parameters:
theBuffer   character buffer to write

void XalanOutputStream::write ( const char * theBuffer ) []
 

Write a null-terminated string to the output file.

The character will not be transcoded.

Parameters:
theBuffer   character buffer to write

void XalanOutputStream::write ( XalanDOMChar theChar ) []
 

Write a wide character to the output stream.

The character will be transcoded, if an output encoding is specified.

Parameters:
theChar   the character to write

void XalanOutputStream::write ( char theChar ) []
 

Write a character to the output stream.

The character will not be transcoded.

Parameters:
theChar   the character to write

virtual void XalanOutputStream::writeData ( const char * theBuffer,
unsigned long theBufferLength ) [protected, pure virtual]
 

Reimplemented in XalanFileOutputStream, XalanNullOutputStream, XalanStdOutputStream, and XalanTransformerOutputStream.


The documentation for this class was generated from the following file:

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.