RWUCharArrayOutputStream Class Reference
[Streams]

Handle class for Unicode character output streams that support an extended interface. More...

#include <rw/stream/RWUCharArrayOutputStream.h>

Inheritance diagram for RWUCharArrayOutputStream:

List of all members.

Public Member Functions
	RWUCharArrayOutputStream (RWUCharArrayOutputStreamImp *body)
	RWUCharArrayOutputStream (const RWUCharArrayOutputStream &handle)
RWUCharArrayOutputStream &	operator= (const RWUCharArrayOutputStream &handle)
RWUChar *	getUCharacterArray ()
RWSize	getUCharacterArraySize () const
void	clear ()

---

Detailed Description

Handle class for Unicode character output streams that support an extended interface. This interface allows retrieval of the output stream's inserted data as a UTF-16 character array. Implements the handle idiom from the handle-body pattern.

Note:

All Unicode-named variables, such as UChar or unicodeArray refer to the Unicode form UTF-16.

---

Constructor & Destructor Documentation

RWUCharArrayOutputStream::RWUCharArrayOutputStream

(

RWUCharArrayOutputStreamImp *

body

)

[inline, explicit]

Constructor.

Parameters:

body

A pointer to an implementation class supporting the abstract interface RWUCharArrayOutputStreamImp.

RWUCharArrayOutputStream::RWUCharArrayOutputStream

(

const RWUCharArrayOutputStream &

handle

)

[inline]

Copy constructor.

Parameters:

handle

A UTF-16 character array stream handle used to initialize the newly created handle.

---

Member Function Documentation

void RWUCharArrayOutputStream::clear

(

void

)

[inline]

Resets the underlying buffer.

RWUChar* RWUCharArrayOutputStream::getUCharacterArray

(

)

[inline]

Returns a pointer to the array of UTF-16 characters inserted into the stream since its creation. Users are responsible for freeing the memory associated with the array returned by this function using operator delete[].

RWSize RWUCharArrayOutputStream::getUCharacterArraySize

(

)

const [inline]

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

RWUCharArrayOutputStream& RWUCharArrayOutputStream::operator=

(

const RWUCharArrayOutputStream &

handle

)

[inline]

Assignment operator. Throws no exceptions.

Parameters:

handle

A UTF-16 character array stream handle used to initialize this handle.