class AbstractFilterReader

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

acdk::io::AbstractFilterReader Class Reference

#include <AbstractFilterReader.h>

Inheritance diagram for acdk::io::AbstractFilterReader:

List of all members.

Detailed Description

Implements a filter for a given Reader.

API: ACDK

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

Version:

Revision: 1.14

Date:

Date: 2005/04/09 19:26:44

Public Member Functions

AbstractFilterReader (IN(RReader) in, IN(acdk::lang::Object) lock=Nil)

virtual void setIn (IN(RReader) reader)

virtual RReader getIn ()

virtual RStorage getStorage ()

Gets the storage reader.

virtual int available ()

returns the number of bytes available in this stream before blocking Some Reader always return 0

virtual void close ()

closes this Reader.

virtual jlong seek (SeekPos seekrel, jlong seekpos)

Set stream position in this Reader to given position.

virtual jlong skip (jlong n)

Move forwart into the stream.

virtual int read ()

read a single byte from stream

virtual int read (IN(RbyteArray) buffer, int offset=0, int len=-1)

read the len bytes into buffer at offset of the buffer

virtual int read (byte *buffer, int offset, int len)

virtual void reset ()

if mark is set, set stream to mark point otherwise to begin of this stream.

virtual bool ready ()

virtual void mark (int readAheadLimit)

virtual bool markSupported ()

virtual RReader getStorageReader ()

Protected Attributes

RReader _in

Constructor & Destructor Documentation

acdk::io::AbstractFilterReader::AbstractFilterReader ( IN(RReader) in,

IN(acdk::lang::Object) lock = Nil

) [inline]

Member Function Documentation

virtual int acdk::io::AbstractFilterReader::available ( ) [inline, virtual]

returns the number of bytes available in this stream before blocking Some Reader always return 0

Reimplemented from acdk::io::Reader.
Reimplemented in acdk::io::BufferedReader, acdk::io::SubReader, and acdk::vfile::InflaterReader.

virtual void acdk::io::AbstractFilterReader::close ( ) [inline, virtual]

closes this Reader.
Note: Some Reader must be closed explicitaly Note: Reader implementation must be avare from closing a reader more than one
Reimplemented from acdk::io::Reader.
Reimplemented in acdk::io::BufferedReader, and acdk::vfile::InflaterReader.

virtual RReader acdk::io::AbstractFilterReader::getIn ( ) [inline, virtual]

virtual RStorage acdk::io::AbstractFilterReader::getStorage ( ) [virtual]

Gets the storage reader.
If this contains an FilterReader instead of a Storage, the storage reader of this filter reader will be returned (recursive).
Implements acdk::io::FilterReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, and acdkx::orb::CDRObjectReader.

virtual RReader acdk::io::AbstractFilterReader::getStorageReader ( ) [inline, virtual]

Implements acdk::io::FilterReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, and acdkx::orb::CDRObjectReader.

virtual void acdk::io::AbstractFilterReader::mark ( int readAheadLimit ) [inline, virtual]

Reimplemented from acdk::io::Reader.
Reimplemented in acdk::io::BufferedReader, acdk::io::LineNumberReader, and acdk::vfile::InflaterReader.

virtual bool acdk::io::AbstractFilterReader::markSupported ( ) [inline, virtual]

Reimplemented from acdk::io::Reader.
Reimplemented in acdk::io::BufferedReader, acdk::io::PushbackReader, and acdk::vfile::InflaterReader.

virtual int acdk::io::AbstractFilterReader::read ( byte * buffer,

int offset,

int len

) [inline, virtual]

See also:
other read(RbyteArray, int, int)

Reimplemented from acdk::io::AbstractReader.
Reimplemented in acdk::io::BinaryObjectReader, acdk::io::BufferedReader, acdk::io::LineNumberReader, acdk::io::PushbackReader, acdk::io::SubReader, acdk::io::TeeReader, acdk::net::TransRateReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

virtual int acdk::io::AbstractFilterReader::read ( IN(RbyteArray) buffer,

int offset = 0,

int len = -1

) [inline, virtual]

read the len bytes into buffer at offset of the buffer

Parameters:

buffer where to write the bytes

offset offset to write into buffer

len how many bytes to read. if == -1 read into many bytes, that fits into buffer (buffer->length() - offset) ``

Returns:
number of bytes readed. may less than input if EOS is reached

Exceptions:

EOF exception, if trying to read behind EOS

Reimplemented from acdk::io::AbstractReader.
Reimplemented in acdk::io::BinaryObjectReader, acdk::io::BufferedReader, acdk::io::LineNumberReader, acdk::io::PushbackReader, acdk::io::SubReader, acdk::io::TeeReader, acdk::net::TransRateReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

virtual int acdk::io::AbstractFilterReader::read ( ) [inline, virtual]

read a single byte from stream

Returns:
the byte readed or -1 if EOS.

Exceptions:

EOF exception, if trying to read behind EOS

Reimplemented from acdk::io::AbstractReader.
Reimplemented in acdk::io::BinaryObjectReader, acdk::io::BufferedReader, acdk::io::LineNumberReader, acdk::io::PushbackReader, acdk::io::SubReader, acdk::io::TeeReader, acdk::net::TransRateReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

virtual bool acdk::io::AbstractFilterReader::ready ( ) [inline, virtual]

Returns:
true, if at least 1 byte can be readed from stream

Reimplemented from acdk::io::Reader.
Reimplemented in acdk::io::BufferedReader, acdk::io::PushbackReader, and acdk::vfile::InflaterReader.

virtual void acdk::io::AbstractFilterReader::reset ( ) [inline, virtual]

if mark is set, set stream to mark point otherwise to begin of this stream.

Implements acdk::io::AbstractReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, acdk::io::BufferedReader, acdk::io::LineNumberReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

virtual jlong acdk::io::AbstractFilterReader::seek ( SeekPos seekrel,

jlong seekpos

) [inline, virtual]

Set stream position in this Reader to given position.

Returns:
the absolute position in this stream

Reimplemented from acdk::io::AbstractReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, acdk::io::BufferedReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

virtual void acdk::io::AbstractFilterReader::setIn ( IN(RReader) reader ) [inline, virtual]

Implements acdk::io::FilterReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, and acdkx::orb::CDRObjectReader.

virtual jlong acdk::io::AbstractFilterReader::skip ( jlong n ) [inline, virtual]

Move forwart into the stream.

Returns:
how many bytes skipped. May less then input, in case EOS is reached

Reimplemented from acdk::io::AbstractReader.
Reimplemented in acdk::io::AbstractObjectReader, acdk::io::ASCIIDataReader, acdk::io::BinaryDataReader, acdk::io::BufferedReader, acdk::io::PushbackReader, acdk::io::SubReader, acdk::vfile::InflaterReader, and acdkx::orb::CDRObjectReader.

Member Data Documentation

RReader acdk::io::AbstractFilterReader::_in [protected]