2005/5/9

--
down ACDK
down API Docs
down Namespaces
down acdk
down acdk::io
down AbstractCharReader
  down members
See also:
  down AbstractCharReader.cpp
  down AbstractCharReader.h

(c) 2005 by
Roger Rene Kommer

Kindly hosted at:
SourceForge.net Logo

     
 

class AbstractCharReader
artefaktur
Modules   Namespace List   Class Hierarchy   Alphabetical List   Compound List   Namespace Members   Compound Members   Related Pages  

acdk::io::AbstractCharReader Class Reference

#include <AbstractCharReader.h>

Inheritance diagram for acdk::io::AbstractCharReader:

acdk::lang::Object acdk::io::CharReader acdk::lang::ObjectBase acdk::lang::dmi::StdDispatch acdk::io::AbstractCharFilterReader acdk::io::ByteToCharReader acdk::io::ConsoleCharReader acdk::io::StringReader acdk::io::InputReader acdk::io::LineNumberCharReaderImpl acdk::io::PushbackCharReaderImpl List of all members.

Detailed Description

Abstract implementation for CharReader.

This class already implements the IO locking mechanism.

API: ACDK

Author:
Roger Rene Kommer (mailto:kommer@artefaktur.com)
Version:
Revision
1.8
Date:
Date
2005/04/09 19:26:44


Public Member Functions

 AbstractCharReader (IN(acdk::lang::Object) lock=Nil)
void lock ()
 lock the object instance.

void unlock ()
 unlock the object instance Note: Will be overwritten by acdk::io::Reader and acdk::io::Writer Note: if Unsynchronized or isStack is set, this call will have no effect

void setLock (IN(acdk::lang::Object) obj)
 API: enhanced Set the acdk::lang::Object, which will be used for synchronization.

acdk::lang::Object getLock ()
 API: enhanced.

virtual int readChar ()=0
 read one char.

virtual RString readString ()
 read until EOF and return as string


Protected Attributes

acdk::lang::Object _iolock

Constructor & Destructor Documentation

acdk::io::AbstractCharReader::AbstractCharReader (  IN(acdk::lang::Object)  lock = Nil  )  [inline]
 

Member Function Documentation

acdk::lang::Object acdk::io::AbstractCharReader::getLock (   )  [inline]
 

API: enhanced.

Returns:
the acdk::lang::Object, which will be used for synchronization

void acdk::io::AbstractCharReader::lock (   )  [inline, virtual]
 

lock the object instance.

Note: Will be overwritten by acdk::io::Reader and acdk::io::Writer Note: if Unsynchronized or isStack is set, this call will have no effect

Reimplemented from acdk::lang::ObjectBase.

virtual int acdk::io::AbstractCharReader::readChar (   )  [pure virtual]
 

read one char.

Returns:
-1 if end of file

Implements acdk::io::CharReader.

Implemented in acdk::io::AbstractCharFilterReader, acdk::io::ByteToCharReader, acdk::io::ConsoleCharReader, acdk::io::LineNumberCharReaderImpl, acdk::io::PushbackCharReaderImpl, and acdk::io::StringReader.

virtual RString acdk::io::AbstractCharReader::readString (   )  [virtual]
 

read until EOF and return as string

Implements acdk::io::CharReader.

Reimplemented in acdk::io::AbstractCharFilterReader, acdk::io::ByteToCharReader, acdk::io::LineNumberCharReaderImpl, acdk::io::PushbackCharReaderImpl, and acdk::io::StringReader.

void acdk::io::AbstractCharReader::setLock (  IN(acdk::lang::Object)  obj  )  [inline]
 

API: enhanced Set the acdk::lang::Object, which will be used for synchronization.

void acdk::io::AbstractCharReader::unlock (   )  [inline, virtual]
 

unlock the object instance Note: Will be overwritten by acdk::io::Reader and acdk::io::Writer Note: if Unsynchronized or isStack is set, this call will have no effect

Reimplemented from acdk::lang::ObjectBase.

Member Data Documentation

acdk::lang::Object acdk::io::AbstractCharReader::_iolock [protected]