RWFilteredUCharInputStreamImp Class Reference
[Streams]

Abstract base class for all the filtered UTF-16 character input stream implementation classes. More...

#include <rw/stream/RWFilteredUCharInputStreamImp.h>

Inheritance diagram for RWFilteredUCharInputStreamImp:

List of all members.

Public Member Functions
virtual	~RWFilteredUCharInputStreamImp ()
virtual void	close ()
virtual bool	isBad () const
virtual bool	isFail () const
virtual bool	isEof () const
virtual bool	isGood () const
virtual RWUChar	read ()
virtual RWSize	read (RWUChar *unicodeArray, RWSize numUChars)
virtual RWSize	readUntil (RWUChar *unicodeArray, RWSize maxSize, RWUChar delim)
virtual RWSize	available () const
virtual RWSize	skip (RWSize numUnits)
Protected Member Functions
	RWFilteredUCharInputStreamImp (const RWUCharInputStream &sourceStream)
RWUCharInputStream &	getSourceStream ()
const RWUCharInputStream &	getSourceStream () const

---

Detailed Description

Abstract base class for all the filtered UTF-16 character input stream implementation classes. A filtered input stream is a stream that uses its attached input stream as the source of elements to its own functions. Implements the body idiom from the handle-body pattern.

---

Constructor & Destructor Documentation

virtual RWFilteredUCharInputStreamImp::~RWFilteredUCharInputStreamImp

(

)

[virtual]

Destructor. Throws no exceptions.

RWFilteredUCharInputStreamImp::RWFilteredUCharInputStreamImp

(

const RWUCharInputStream &

sourceStream

)

[inline, protected]

Used by derived classes to initialize the attached source stream.

Parameters:

sourceStream

A handle to the attached source stream.

---

Member Function Documentation

virtual RWSize RWFilteredUCharInputStreamImp::available

(

)

const [virtual]

Returns the number of UTF-16 characters that can be read from the attached source stream without blocking. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual void RWFilteredUCharInputStreamImp::close

(

)

[virtual]

Forwards the close() request to the attached source stream.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

const RWUCharInputStream& RWFilteredUCharInputStreamImp::getSourceStream

(

)

const [inline, protected]

Returns a handle to the attached source stream. Throws no exceptions.

RWUCharInputStream& RWFilteredUCharInputStreamImp::getSourceStream

(

)

[inline, protected]

Returns a handle to the attached source stream. Throws no exceptions.

virtual bool RWFilteredUCharInputStreamImp::isBad

(

)

const [virtual]

Forwards the isBad() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual bool RWFilteredUCharInputStreamImp::isEof

(

)

const [virtual]

Forwards the isEof() request to the attached source stream. Throws no exceptions.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual bool RWFilteredUCharInputStreamImp::isFail

(

)

const [virtual]

Forwards the isFail() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual bool RWFilteredUCharInputStreamImp::isGood

(

)

const [virtual]

Forwards the isGood() request to the attached source stream. Throws no exceptions.

Implements RWStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual RWSize RWFilteredUCharInputStreamImp::read	(	RWUChar *	unicodeArray,
		RWSize	numUChars
	)			[virtual]

Forwards the reading of an array of UTF-16 characters from the attached source stream. The function returns the actual number of UTF-16 characters read.

Parameters:

	unicodeArray	A pointer to the first element of the array. The array must have been pre-allocated to contain at least numUChars elements.
	numUChars	The number of unicode character(s) to be read from the stream.

Implements RWUCharInputStreamImp.

virtual RWUChar RWFilteredUCharInputStreamImp::read

(

)

[virtual]

Forwards the reading of a single UTF-16 character from the attached source stream.

Implements RWUCharInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.

virtual RWSize RWFilteredUCharInputStreamImp::readUntil	(	RWUChar *	unicodeArray,
		RWSize	maxSize,
		RWUChar	delim
	)			[virtual]

Reads UTF-16 characters from the attached source stream until the last UTF-16 character read is equal to delim, or maxSize UTF-16 characters have been read, or the end of the input sequence is reached. The UTF-16 characters read are stored in unicodeArray. The function returns the actual number of UTF-16 characters read from the stream.

Parameters:

	unicodeArray	A pointer to the array receiving the UTF-16 character(s) extracted from the stream.
	maxSize	The maximum number of UTF-16 character(s) to be read.
	delim	The UTF-16 character used as a delimeter.

Implements RWUCharInputStreamImp.

Reimplemented in RWSynchronizedUCharInputStreamImp.

virtual RWSize RWFilteredUCharInputStreamImp::skip

(

RWSize

numUnits

)

[virtual]

Skips numUnits UTF-16 characters from the input sequence of the attached source stream if possible. The function returns the actual number of UTF-16 characters skipped, which can be any value between 0 and numUnits.

Parameters:

numUnits

The number of unicode character(s) to be skipped.

Implements RWInputStreamImp.

Reimplemented in RWTInputStreamLockImp< RWUCharInputStream, RWFilteredUCharInputStreamImp >.