Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.11


Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Attributes

XalanOutputStream Class Reference

#include <XalanOutputStream.hpp>

Inherited by XalanFileOutputStream, XalanFStreamOutputStream, XalanNullOutputStream, XalanStdOutputStream, and XalanTransformerOutputStream.

Collaboration diagram for XalanOutputStream:
Collaboration graph
[legend]

List of all members.

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes


Detailed Description

Definition at line 49 of file XalanOutputStream.hpp.


Member Typedef Documentation

Definition at line 55 of file XalanOutputStream.hpp.

Definition at line 57 of file XalanOutputStream.hpp.

Definition at line 56 of file XalanOutputStream.hpp.


Member Enumeration Documentation

anonymous enum
Enumerator:
eDefaultBufferSize 
eDefaultTranscoderBlockSize 

Definition at line 53 of file XalanOutputStream.hpp.


Constructor & Destructor Documentation

XalanOutputStream::XalanOutputStream ( MemoryManager &  theManager,
size_type  theBufferSize = eDefaultBufferSize,
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

bool XalanOutputStream::canTranscodeTo ( XalanUnicodeChar  theChar  )  const

Determine if a given value can be represented in the output encoding.

Returns:
true if the value can be represented, and false if not.
static const XalanDOMChar* XalanOutputStream::defaultNewlineString (  )  [inline, static]

Definition at line 83 of file XalanOutputStream.hpp.

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

Flush the stream's buffer.

Definition at line 116 of file XalanOutputStream.hpp.

void XalanOutputStream::flushBuffer (  ) 

Flush the stream's transcoding buffer, but do not request the implementation class to flush its buffer.

static XalanDOMString& XalanOutputStream::formatMessage ( const XalanDOMString theMessage,
int  theErrorCode,
XalanDOMString theBuffer 
) [static]
MemoryManager& XalanOutputStream::getMemoryManager (  )  [inline]

Definition at line 77 of file XalanOutputStream.hpp.

virtual const XalanDOMChar* XalanOutputStream::getNewlineString (  )  const [virtual]

Get the string which is appropriate for inserting a line feed in the stream.

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

Get the output encoding for the stream.

Returns:
The encoding name

Definition at line 220 of file XalanOutputStream.hpp.

bool XalanOutputStream::getThrowTranscodeException (  )  const [inline]

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.

Definition at line 259 of file XalanOutputStream.hpp.

const XalanOutputTranscoder* XalanOutputStream::getTranscoder (  )  const [inline]

Definition at line 244 of file XalanOutputStream.hpp.

virtual void XalanOutputStream::newline (  )  [virtual]

Write the appropriate newline character(s) to the stream.

void XalanOutputStream::setBufferSize ( 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  )  [inline]

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.

Definition at line 274 of file XalanOutputStream.hpp.

void XalanOutputStream::transcode ( const XalanDOMChar *  theBuffer,
size_type  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 char *  theBuffer  )  [inline]

Write a null-terminated string to the output file.

The character will not be transcoded. The caller is responsible for making sure the buffer is flushed before calling this member function.

Parameters:
theBuffer character buffer to write

Definition at line 162 of file XalanOutputStream.hpp.

void XalanOutputStream::write ( XalanDOMChar  theChar  )  [inline]

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

Definition at line 142 of file XalanOutputStream.hpp.

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

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

Definition at line 177 of file XalanOutputStream.hpp.

void XalanOutputStream::write ( const XalanDOMChar *  theBuffer,
size_type  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 ( char  theChar  )  [inline]

Write a character to the output stream.

The character will not be transcoded.

Parameters:
theChar the character to write

Definition at line 130 of file XalanOutputStream.hpp.

void XalanOutputStream::write ( const char *  theBuffer,
size_type  theBufferLength 
) [inline]

Write a specified number of characters to the output stream.

The string will not be transcoded. The caller is responsible for making sure the buffer is flushed before calling this member function.

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

Definition at line 191 of file XalanOutputStream.hpp.

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

Write the data in the buffer.

Parameters:
theBuffer The data to write
theBufferLength The length of theBuffer.

Implemented in XalanTransformerOutputStream, XalanFileOutputStream, XalanFStreamOutputStream, XalanNullOutputStream, and XalanStdOutputStream.


Member Data Documentation

const XalanDOMChar XalanOutputStream::s_nlCRString[] [static, protected]

Definition at line 441 of file XalanOutputStream.hpp.

Definition at line 444 of file XalanOutputStream.hpp.

const XalanDOMChar XalanOutputStream::s_nlString[] [static, protected]

Definition at line 440 of file XalanOutputStream.hpp.

Definition at line 443 of file XalanOutputStream.hpp.


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++ XSLT Processor Version 1.11
Copyright © 1999-2012 The Apache Software Foundation.
All Rights Reserved.

Apache Logo