RWChainedUCharArrayOutputStreamImp Class Reference
[Streams]

Concrete class implementing the UTF-16 character array output stream interface. More...

#include <rw/stream/RWChainedUCharArrayOutputStreamImp.h>

Inheritance diagram for RWChainedUCharArrayOutputStreamImp:

List of all members.

Public Member Functions
virtual	~RWChainedUCharArrayOutputStreamImp ()
virtual RWUChar *	getUCharacterArray ()
virtual RWSize	getUCharacterArraySize () const
virtual void	clear ()
virtual void	close ()
virtual void	flush ()
virtual bool	isBad () const
virtual bool	isFail () const
virtual bool	isGood () const
virtual void	write (RWUChar unicodeValue)
virtual void	write (const RWUChar *unicodeArray, RWSize numUChars)
Static Public Member Functions
static RWUCharArrayOutputStream	make ()
Protected Member Functions
	RWChainedUCharArrayOutputStreamImp ()
RWChainedMemoryStreambuf &	getSinkBuff ()
const RWChainedMemoryStreambuf &	getSinkBuff () const

---

Detailed Description

Concrete class implementing the UTF-16 character array output stream interface. UTF-16 characters inserted into an instance of class RWChainedUCharArrayOutputStreamImp are stored in memory using an instance of class RWChainedMemoryStreambuf. Implements the body idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

virtual RWChainedUCharArrayOutputStreamImp::~RWChainedUCharArrayOutputStreamImp

(

)

[virtual]

Destructor.

RWChainedUCharArrayOutputStreamImp::RWChainedUCharArrayOutputStreamImp

(

)

[inline, protected]

Constructor.

---

Member Function Documentation

virtual void RWChainedUCharArrayOutputStreamImp::clear

(

)

[virtual]

Reset the underlying buffer.

Implements RWUCharArrayOutputStreamImp.

virtual void RWChainedUCharArrayOutputStreamImp::close

(

)

[virtual]

This function calls flush().

Reimplemented from RWOutputStreamImp.

virtual void RWChainedUCharArrayOutputStreamImp::flush

(

)

[virtual]

Forward the flush() request to the internal RWChainedMemoryStreambuf object.

Implements RWOutputStreamImp.

const RWChainedMemoryStreambuf& RWChainedUCharArrayOutputStreamImp::getSinkBuff

(

)

const [inline, protected]

Returns a reference to the RWChainedMemoryStreambuf, which is used as the sink of UTF-16 characters.

RWChainedMemoryStreambuf& RWChainedUCharArrayOutputStreamImp::getSinkBuff

(

)

[inline, protected]

Returns a reference to the RWChainedMemoryStreambuf, which is used as the sink of UTF-16 characters.

virtual RWUChar* RWChainedUCharArrayOutputStreamImp::getUCharacterArray

(

)

[virtual]

Returns a pointer to an array of UTF-16 characters containing the UTF-16 characters inserted into the stream since its creation, or since the last invocation of function getUCharacterArray(), or function clear(). Users are responsible for freeing the memory associated with the array returned by this function, by using operator delete[].

Implements RWUCharArrayOutputStreamImp.

virtual RWSize RWChainedUCharArrayOutputStreamImp::getUCharacterArraySize

(

)

const [virtual]

Returns the size of the UTF-16 character array that would be returned by a call to function getUCharacterArray().

Implements RWUCharArrayOutputStreamImp.

virtual bool RWChainedUCharArrayOutputStreamImp::isBad

(

)

const [virtual]

These functions return true if the last operation performed on the internal RWChainedMemoryStreambuf object failed.

Implements RWStreamImp.

virtual bool RWChainedUCharArrayOutputStreamImp::isFail

(

)

const [virtual]

These functions return true if the last operation performed on the internal RWChainedMemoryStreambuf object failed.

Implements RWStreamImp.

virtual bool RWChainedUCharArrayOutputStreamImp::isGood

(

)

const [virtual]

Returns true if the last operation performed on the internal RWChainedMemoryStreambuf object succeeded.

Implements RWStreamImp.

static RWUCharArrayOutputStream RWChainedUCharArrayOutputStreamImp::make

(

void

)

[inline, static]

Constructs an RWChainedUCharArrayOutputStreamImp instance that uses an instance of class RWChainedMemoryStreambuf to store UTF-16 characters. The function returns a handle to the implementation class.

virtual void RWChainedUCharArrayOutputStreamImp::write	(	const RWUChar *	unicodeArray,
		RWSize	numUChars
	)			[virtual]

Writes an array of UTF-16 characters to the stream. Throws exception RWIncompleteStreamOperation.

Parameters:

	unicodeArray	A pointer to the first element of the array
	numUChars	The number of UTF-16 characters to be written.

Implements RWUCharOutputStreamImp.

virtual void RWChainedUCharArrayOutputStreamImp::write

(

RWUChar

unicodeValue

)

[virtual]

Writes a single UTF-16 character to the stream. Throws exception RWIncompleteStreamOperation.

Parameters:

unicodeValue

The UTF-16 character to be written.

Implements RWUCharOutputStreamImp.