Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.10

Public Member Functions | Protected Member Functions | List of all members
XalanTransformerOutputStream Class Reference
Inheritance diagram for XalanTransformerOutputStream:
XalanOutputStream

Public Member Functions

 XalanTransformerOutputStream (MemoryManagerType &theManager, void *theOutputHandle, XalanOutputHandlerType theOutputHandler, XalanFlushHandlerType theFlushHandler=0)
 Construct a XalanTransformerOutputStream instance for output to a user defined (callback) function. More...
 
virtual ~XalanTransformerOutputStream ()
 
- Public Member Functions inherited from XalanOutputStream
 XalanOutputStream (MemoryManagerType &theManager, size_type theBufferSize=eDefaultBufferSize, size_type theTranscoderBlockSize=eDefaultTranscoderBlockSize, bool fThrowTranscodeException=true)
 Constructor. More...
 
virtual ~XalanOutputStream ()
 
MemoryManagerTypegetMemoryManager ()
 
virtual void newline ()
 Write the appropriate newline character(s) to the stream. More...
 
virtual const XalanDOMChar * getNewlineString () const
 Get the string which is appropriate for inserting a line feed in the stream. More...
 
void flushBuffer ()
 Flush the stream's transcoding buffer, but do not request the implementation class to flush its buffer. More...
 
void flush ()
 Flush the stream's buffer. More...
 
void write (char theChar)
 Write a character to the output stream. More...
 
void write (XalanDOMChar theChar)
 Write a wide character to the output stream. More...
 
void write (const char *theBuffer)
 Write a null-terminated string to the output file. More...
 
void write (const XalanDOMChar *theBuffer)
 Write a null-terminated wide string to the output file. More...
 
void write (const char *theBuffer, size_type theBufferLength)
 Write a specified number of characters to the output stream. More...
 
void write (const XalanDOMChar *theBuffer, size_type theBufferLength)
 Write a specified number of characters to the output stream. More...
 
const XalanDOMStringgetOutputEncoding () const
 Get the output encoding for the stream. More...
 
void setOutputEncoding (const XalanDOMString &theEncoding)
 Set the output encoding for the stream. More...
 
bool canTranscodeTo (UnicodeCharType theChar) const
 Determine if a given value can be represented in the output encoding. More...
 
const XalanOutputTranscodergetTranscoder () const
 
bool getThrowTranscodeException () const
 Set the flag that indicates whether a transcoding error should throw an exception. More...
 
void setThrowTranscodeException (bool flag)
 Set the flag that indicates whether a transcoding error should throw an exception. More...
 
void setBufferSize (size_type theBufferSize)
 Set the size of the output buffer. More...
 

Protected Member Functions

virtual void writeData (const char *theBuffer, size_type theBufferLength)
 Write the data in the buffer. More...
 
virtual void doFlush ()
 Flush the stream. More...
 
- Protected Member Functions inherited from XalanOutputStream
void transcode (const XalanDOMChar *theBuffer, size_type theBufferLength, TranscodeVectorType &theDestination)
 Transcode a wide string. More...
 

Additional Inherited Members

- Public Types inherited from XalanOutputStream
enum  { eDefaultBufferSize = 512u, eDefaultTranscoderBlockSize = 1024u }
 
typedef XalanVector< XalanDOMChar > BufferType
 
typedef XalanVector< char > TranscodeVectorType
 
typedef
XalanTranscodingServices::size_type 
size_type
 
typedef
XalanTranscodingServices::UnicodeCharType 
UnicodeCharType
 
- Static Public Member Functions inherited from XalanOutputStream
static const XalanDOMChar * defaultNewlineString ()
 
- Static Protected Attributes inherited from XalanOutputStream
static const XalanDOMChar s_nlString []
 
static const XalanDOMChar s_nlCRString []
 
static const
XalanDOMString::size_type 
s_nlStringLength
 
static const
XalanDOMString::size_type 
s_nlCRStringLength
 

Constructor & Destructor Documentation

XalanTransformerOutputStream::XalanTransformerOutputStream ( MemoryManagerType theManager,
void *  theOutputHandle,
XalanOutputHandlerType  theOutputHandler,
XalanFlushHandlerType  theFlushHandler = 0 
)

Construct a XalanTransformerOutputStream instance for output to a user defined (callback) function.

Parameters
theOutputHandlevoid pointer passed through to callback.
theOutputHandlera user defined (callback) function.
theFlushHandlera user defined (callback) function.
virtual XalanTransformerOutputStream::~XalanTransformerOutputStream ( )
virtual

Member Function Documentation

virtual void XalanTransformerOutputStream::doFlush ( )
protectedvirtual

Flush the stream.

Implements XalanOutputStream.

virtual void XalanTransformerOutputStream::writeData ( const char *  theBuffer,
size_type  theBufferLength 
)
protectedvirtual

Write the data in the buffer.

Parameters
theBufferThe data to write
theBufferLengthThe length of theBuffer.

Implements XalanOutputStream.


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.

dot

Xalan-C++ XSLT Processor Version 1.10
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.

Apache Logo