class AbstractWriter

Modules Namespace List Class Hierarchy Alphabetical List Compound List Namespace Members Compound Members Related Pages

acdk::io::AbstractWriter Class Reference

#include <AbstractWriter.h>

Inheritance diagram for acdk::io::AbstractWriter:

List of all members.

Detailed Description

An default implementation of Writer with locking mechanism.

API: ACDK

Author:: Roger Rene Kommer (mailto:kommer@artefaktur.com)

Version:

Revision: 1.13

Date:

Date: 2005/03/01 10:12:47

See also:: Writer

Public Member Functions

AbstractWriter ()

AbstractWriter (IN(acdk::lang::Object) olock)

overwrite void flush ()=0

overwrite void close ()=0

virtual void lock ()

lock the object instance.

virtual 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

virtual void setLock (IN(acdk::lang::Object) obj)

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

virtual acdk::lang::Object getLock ()

API: enhanced.

virtual void write (const byte *cstr, int offset, int len)

overwrite void write (byte c)=0

default implementation: byte cbuf[2]; cbuf[1] = 0; cbuf[0] = c; return write((const byte*)cbuf, 0, 1);

virtual void write (IN(RbyteArray) ch, int offset=0, int len=-1)

default implementation: return write(ch->data(), offset, len == -1 ? ch->length() - offset : len);

Protected Attributes

acdk::lang::RObject iolock

API: JDK modified In the JDK this member variable is named lock.

Constructor & Destructor Documentation

acdk::io::AbstractWriter::AbstractWriter ( ) [inline]

acdk::io::AbstractWriter::AbstractWriter ( IN(acdk::lang::Object) olock ) [inline]

Member Function Documentation

overwrite void acdk::io::AbstractWriter::close ( ) [pure virtual]

Implements acdk::io::Writer.
Implemented in acdk::io::AbstractFilterWriter, acdk::io::BufferedWriter, acdk::io::BytePtrWriter, acdk::io::ByteBufferWriter, acdk::io::ByteBufferAppendWriter, acdk::io::ByteToCharWriter, acdk::io::ConsoleWriter, acdk::io::FileWriter, acdk::io::MemWriter, acdk::io::NullWriter, acdk::io::OutputDebugStringWriter, acdk::io::PipedWriter, acdk::io::TeeWriter, acdk::net::srfsys::SRSFileWriter, and acdk::vfile::DeflateWriter.

overwrite void acdk::io::AbstractWriter::flush ( ) [pure virtual]

Implements acdk::io::Writer.
Implemented in acdk::io::AbstractFilterWriter, acdk::io::AbstractObjectWriter, acdk::io::ASCIIDataWriter, acdk::io::BinaryDataWriter, acdk::io::BufferedWriter, acdk::io::BytePtrWriter, acdk::io::ByteBufferWriter, acdk::io::ByteBufferAppendWriter, acdk::io::ByteToCharWriter, acdk::io::ConsoleWriter, acdk::io::FileWriter, acdk::io::MemWriter, acdk::io::NullWriter, acdk::io::OutputDebugStringWriter, acdk::io::PipedWriter, acdk::io::TeeWriter, acdk::vfile::DeflateWriter, and acdkx::orb::CDRObjectWriter.

virtual acdk::lang::Object acdk::io::AbstractWriter::getLock ( ) [inline, virtual]

API: enhanced.

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

virtual void acdk::io::AbstractWriter::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 void acdk::io::AbstractWriter::setLock ( IN(acdk::lang::Object) obj ) [inline, virtual]

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

virtual void acdk::io::AbstractWriter::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.

virtual void acdk::io::AbstractWriter::write ( IN(RbyteArray) ch,

int offset = 0,

int len = -1

) [inline, virtual]

default implementation: return write(ch->data(), offset, len == -1 ? ch->length() - offset : len);

Reimplemented from acdk::io::Writer.
Reimplemented in acdk::io::AbstractFilterWriter, acdk::io::AbstractObjectWriter, acdk::io::ASCIIDataWriter, acdk::io::BinaryDataWriter, acdk::io::BinaryObjectWriter, acdk::io::BufferedWriter, acdk::io::BytePtrWriter, acdk::io::ByteBufferWriter, acdk::io::ByteBufferAppendWriter, acdk::io::ByteToCharWriter, acdk::io::ConsoleWriter, acdk::io::FileWriter, acdk::io::MemWriter, acdk::io::NullWriter, acdk::io::PipedWriter, acdk::io::TeeWriter, acdk::net::TransRateWriter, acdk::vfile::DeflateWriter, acdk::xml::XMLObjectWriter, and acdkx::orb::CDRObjectWriter.

overwrite void acdk::io::AbstractWriter::write ( byte c ) [pure virtual]

default implementation: byte cbuf[2]; cbuf[1] = 0; cbuf[0] = c; return write((const byte*)cbuf, 0, 1);

Implements acdk::io::Writer.
Implemented in acdk::io::AbstractFilterWriter, acdk::io::AbstractObjectWriter, acdk::io::ASCIIDataWriter, acdk::io::BinaryDataWriter, acdk::io::BinaryObjectWriter, acdk::io::BufferedWriter, acdk::io::BytePtrWriter, acdk::io::ByteBufferWriter, acdk::io::ByteBufferAppendWriter, acdk::io::ByteToCharWriter, acdk::io::ConsoleWriter, acdk::io::FileWriter, acdk::io::MemWriter, acdk::io::NullWriter, acdk::io::OutputDebugStringWriter, acdk::io::PipedWriter, acdk::io::TeeWriter, acdk::net::TransRateWriter, acdk::vfile::DeflateWriter, and acdkx::orb::CDRObjectWriter.

virtual void acdk::io::AbstractWriter::write ( const byte * cstr,

int offset,

int len

) [virtual]

Reimplemented from acdk::io::Writer.
Reimplemented in acdk::io::AbstractFilterWriter, acdk::io::AbstractObjectWriter, acdk::io::ASCIIDataWriter, acdk::io::BinaryDataWriter, acdk::io::BinaryObjectWriter, acdk::io::BufferedWriter, acdk::io::BytePtrWriter, acdk::io::ByteBufferWriter, acdk::io::ByteBufferAppendWriter, acdk::io::ByteToCharWriter, acdk::io::ConsoleWriter, acdk::io::FileWriter, acdk::io::MemWriter, acdk::io::NullWriter, acdk::io::OutputDebugStringWriter, acdk::io::PipedWriter, acdk::io::TeeWriter, acdk::net::TransRateWriter, acdk::vfile::DeflateWriter, and acdkx::orb::CDRObjectWriter.

Member Data Documentation

acdk::lang::RObject acdk::io::AbstractWriter::iolock [protected]

API: JDK modified In the JDK this member variable is named lock.
But this is confusing with the method lock.