artefaktur
software engineer &        architecture

 
 
 
 

namespace acdk::io

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

acdk::io Namespace Reference


Detailed Description

Corresponds to the java.io package, with some modifications.

Implements the classes for Input/Output routines.


Compounds

class  AbstractCharFilterReader
 A filter interface for other CharReader. More...

class  AbstractCharFilterWriter
 Abstract filter for CharWriter. More...

class  AbstractCharReader
 Abstract implementation for CharReader. More...

class  AbstractCharWriter
 Reads character, not bytes Similar to Javas InputStreamReader. More...

class  AbstractFileImpl
 implements a abstract FileImpl If not derived from other class this implementation stands for a file, which does not exists More...

class  AbstractFilterReader
 Implements a filter for a given Reader. More...

class  AbstractFilterWriter
 Implements a filter for a given Writer. More...

class  AbstractObjectReader
 Abstract basic implementation for a ObjectReader. More...

class  AbstractObjectWriter
 Standard implementation for Writing Objects into a stream (Serialization/Marshaling) API: ACDK. More...

class  AbstractReader
 Basic incomplete implementation for a Reader. More...

class  AbstractStorageReader
 Standard incomplete implementation for a StorageReader. More...

class  AbstractStorageWriter
 Standard incomplete implementation for a StorageWriter. More...

class  AbstractWriter
 An default implementation of Writer with locking mechanism. More...

class  ASCIIDataReader
 Filter to writes Data in Binary format. More...

class  ASCIIDataWriter
 Filter to writes Data in ASCII format. More...

class  BinaryDataReader
 Filter to writes Data in Binary format. More...

class  BinaryDataWriter
 Filter to writes Data in Binary format. More...

class  BinaryObjectReader
 Implementation to read Objects and basic type in binary format. More...

class  BinaryObjectWriter
 Implementation to write Objects and basic type in binary format. More...

class  BufferedReader
 Buffers input from a given Reader API: ACDK
. More...

class  BufferedWriter
 Buffers input from a given Writer API: ACDK
. More...

class  ByteBufferAppendWriter
 Reader interface for a ReadByteBuffer. More...

class  ByteBufferPtrReader
 same as ByteBufferReader but ReadByteBuffer supports native iterator More...

class  ByteBufferReader
 Reader interface for a ReadByteBuffer. More...

class  ByteBufferStorage
 helper class More...

class  ByteBufferWriter
 Reader interface for a ReadByteBuffer. More...

class  BytePtrReader
 internal reader class. More...

class  BytePtrWriter
 internal class for a writer into a fix byte buffer More...

class  ByteToCharReader
 Filter translates from a Reader interface to a CharReader interface with the given decoder. More...

class  ByteToCharWriter
 Reads from a CharReader and encodes it to a Reader. More...

class  CharArrayReader
 Reads from an uccharArray API: Java. More...

class  CharArrayWriter
 Reads from an uccharArray API: Java. More...

class  CharReader
 Reads character, not bytes Similar to Javas InputStreamReader. More...

struct  CharStreamPos
 internal structure to hold text position More...

class  CharToByteReader
 Reads from a CharReader and encodes it to a Reader. More...

class  CharToByteWriter
 CharWriter interface which writes the encoded bytes in a given Writer. More...

class  CharWriter
 Reads character, not bytes Similar to Javas InputStreamReader. More...

class  ConfigFileSystemFactory
 helper class for file system factories loaded from configuration More...

class  ConsoleCharReader
 Reads characters from a console (standard input from the process). More...

class  ConsoleCharWriter
 Write character to a Console (standard output or error output) API: ACDK
. More...

class  ConsoleReader
 Read bytes from a console (standard input) API: ACDK
. More...

class  ConsoleWriter
 Writes bytes to a console. More...

class  DataReader
 Interface for reading basic data. More...

class  DataWriter
 Interface for writing basic data types. More...

class  EOFException
 Will be thrown if a Reader try read behind of end of file/input. More...

class  File
 The File class is a fassade to a virtual filesystem. More...

class  FileAbstractImpl
 Abstract/incomplete implementation of the FileImpl interface. More...

class  FileDescriptor
 Represents a operation system file descriptor. More...

class  FileFilter
 Filter used in connection of the acdk::io::File class. More...

class  FileImpl
 This Interface should implement the File operations. More...

class  FileInfo
 Hold logical information of a file Important: The information about the file is cached and may get out of sync with the read file information. More...

class  FilenameFilter
 Filter used in connection the acdk::io::File class. More...

class  FileNotFoundException
 Will be thrown if a method cannot find a given name. More...

class  FileReader
 Read bytes from a File. More...

class  FileReaderWriterImpl
 Internal Implementation base of FileReader and FileWriter. More...

class  FileStandardImpl
 Implementation of the FileImpl interface for standard operation system files. More...

class  FileStatus
 FileStatus operates on normal files Normally doesn't used directly. More...

class  FileSystem
 This Interface should implement the basic Filesystem operations. More...

class  FileSystemFactory
 Interface to a factory for file system by name. More...

class  FileWriter
 byte Writer into a file API: ACDK
More...

class  FilterReader
 Interface for a reader filter. More...

class  FilterWriter
 Interface for a writer filter API: ACDK
. More...

class  GlobFilenameFilter
 Provides simply Globbing with pattern like '*.h' API: Java Extended
Using fnmatch on unix system, and a similar (propably less powerfull) matching function on NT. More...

class  InputReader
 The Class InputReader is the counterpart to PrintWriter. More...

class  InvalidClassException
 API: Java<br/>. More...

class  IOException
 Signals error in IO operations. More...

class  JoinedReader
 Joines multiple Reader to one virtual stream API: ACDK
. More...

class  LineNumberCharReader
 Similar to acdk::io::LineNumberReader, but based on CharReader. More...

class  LineNumberCharReaderImpl
 Standard filter implementation LineNumberCharReader. More...

class  LineNumberReader
 A filter reader provides information about line and column of current read position. More...

class  LittleBytesReader
 helper for ByteToCharWriter. More...

class  LittleBytesWriter
 helper for CharToByteReader. More...

class  MemoryMappedFile
 Non function stub. More...

class  MemReader
 Provide a Reader interface to a byteArray API: ACDK<br/>. More...

class  MemWriter
 Provides a Writer interface to byteArray. More...

class  NotSerializableException
 API: Java<br/>. More...

class  NullWriter
 This class is the implementation of Writer to /dev/null. More...

class  ObjectReader
 Interface for reading basic and object types. More...

class  ObjectStreamException
 Signals an error in operations of ObjectReader or ObjectWriter. More...

class  ObjectWriter
 Interface to write Objects. More...

class  OutputDebugStringWriter
 On MS Windows application this Writer uses OutputDebugStringA() to write to debugger console. More...

class  PipedReader
 A create a Reader end of a pipe construct. More...

class  PipedWriter
 A create a Reader end of a pipe construct. More...

class  PrintWriter
 PrintWriter provides formated character output. More...

class  PushbackCharReader
 CharReader where character can be pushed back into the stream. More...

class  PushbackCharReaderImpl
 API: ACDK<br/>. More...

class  PushbackReader
 CharReader where bytes can be pushed back into the stream. More...

class  RandomAccessFile
 Access a standard system file. More...

class  Reader
 General byte base reader. More...

class  RessourceDir
 Internal class implementing in C++ source embedded directory. More...

class  RessourceFile
 Internal class implementing in C++ source embedded file. More...

class  RessourceFileImpl
 Provides a File implementation for the FileImpl interface which can be embedded into C++ source code. More...

class  RessourceFileSystem
 Implements internal ressource storage embedded into C++ source code. More...

class  RessourceFileSystemFactory
 Factory for the acdk::io::RessourceFileSystem. More...

class  Serializable
 Tag interface to declare a class as serializable. More...

class  SerializedFieldDescriptor
 used to describe a serialized class. More...

class  SerializedObjectDescriptor
 Similar to ObjectStreamClass in Java. More...

class  StandardFileSystem
 The StandardFileSystem implements the FileSystem for standard OS files. More...

class  Storage
 An Storage is an interface to query information of IO-Storages. More...

class  StreamCorruptedException
 API: Java<br/>. More...

class  StreamEndline
class  StreamTokenizer
 Parses a character stream to token. More...

class  StringReader
 Reads character from a given String. More...

class  StringWriter
 Reads character, not bytes Similar to Javas InputStreamReader. More...

class  SubReader
 A SubReader is a filter, which reads a segement from another reader
API: ACDK. More...

class  TeeCharWriter
 Duplicate written characters into two given CharWriter. More...

class  TeeReader
 Tee reader spawn a reader stream into 1 reader and 1 writer streams. More...

class  TeeWriter
 Tee writer spawn a writer stream to 2 writer streams API: ACDK
The default operatations of FilterWriter acts on the first output Writer. More...

class  Writer
 Different to JDK a Writer (an Reader too) are not classes, but only Interfaces. More...


Typedefs

typedef DataReader DataInput
typedef RDataReader RDataInput
typedef DataWriter DataOutput
typedef RDataWriter RDataOutput
typedef ObjectReader ObjectInput
typedef RObjectReader RObjectInput
typedef ObjectWriter ObjectOutput
typedef RObjectWriter RObjectOutput

Enumerations

enum  SerializeFlags {
  SerializeNamed = 0x0001, SerializeTagged = 0x0002, SerializeLabeled = 0x0004, SerializeReduced = 0x0008,
  SerializeJoinedStrings = 0x0010, SerializeOnlySerializable = 0x0020, SerializeAll = 0x0040, SerializeIgnoreNotSerializable = 0x0080,
  SerializeCheckCompatVersion = 0x0100, SerializeUseSerializedObjectDescriptor = 0x0200, SerializeDefaultFlags
}
 a combination of SerializeFlags controls how to serialize in acdk::io::AbstractObjectWriter and acdk::io::AbstractObjectReader More...

enum  InChannel { InvalidInChannel = -1, CinInChannel = 0 }
 helper enum for ConsoleReader More...

enum  ConsoleOutChannel { InvalidConsoleOutChannel = -1, CoutOutChannel = 1, CerrOutChannel = 2 }
 Channel of a console. More...

enum  FileInfoFlags {
  FileInfoExists = 0x0001, FileInfoIsFile = 0x0002, FileInfoIsDir = 0x0004, FileInfoCanRead = 0x0010,
  FileInfoCanWrite = 0x0020, FileInfoCanExec = 0x0040, FileInfoIsHidden = 0x0100, FileInfoHasABit = 0x0200,
  FileInfoChecked = 0x1000
}
 Information about file. More...

enum  FileListFlags {
  FileListFiles = 0x0001, FileListDirectories = 0x0002, FileListBoth = 0x0003, FileListRecursive = 0x0004,
  FileListAllReadable = 0x0010
}
 used in acdk::io::FileSystem More...

enum  SeekPos { SeekCur, SeekEnd, SeekSet }
 used by Reader::seek(SeekPos seekrel, jlong seekpos) to determine the seek direction More...


Functions

bool operator== (IN(RFileDescriptor) f, IN(RFileDescriptor) s)
bool operator!= (IN(RFileDescriptor) f, IN(RFileDescriptor) s)
template<typename T> PrintWriteroperator<< (PrintWriter &p, const RefHolder< T > &b)
PrintWriteroperator<< (PrintWriter &p, const RString &b)
template<typename T> PrintWriteroperator<< (RPrintWriter &rp, const RefHolder< T > &b)
PrintWriteroperator<< (RPrintWriter &rp, const RString &b)
template<class T> PrintWriteroperator<< (PrintWriter &p, T *b)
template<class T> PrintWriteroperator<< (RPrintWriter &rp, T *b)
PrintWriteroperator<< (PrintWriter &p, bool b)
PrintWriteroperator<< (PrintWriter &p, char b)
PrintWriteroperator<< (PrintWriter &p, byte b)
PrintWriteroperator<< (PrintWriter &p, short b)
PrintWriteroperator<< (PrintWriter &p, int b)
PrintWriteroperator<< (PrintWriter &p, jlong b)
PrintWriteroperator<< (PrintWriter &p, float b)
PrintWriteroperator<< (PrintWriter &p, double b)
PrintWriteroperator<< (RPrintWriter &rp, bool b)
PrintWriteroperator<< (RPrintWriter &rp, char b)
PrintWriteroperator<< (RPrintWriter &rp, byte b)
PrintWriteroperator<< (RPrintWriter &rp, short b)
PrintWriteroperator<< (RPrintWriter &rp, int b)
PrintWriteroperator<< (RPrintWriter &rp, jlong b)
PrintWriteroperator<< (RPrintWriter &rp, float b)
PrintWriteroperator<< (RPrintWriter &rp, double b)
PrintWriteroperator<< (PrintWriter &p, const char *b)
PrintWriteroperator<< (PrintWriter &p, char *b)
PrintWriteroperator<< (RPrintWriter &rp, const char *b)
PrintWriteroperator<< (RPrintWriter &rp, char *b)
PrintWriteroperator<< (PrintWriter &p, const StreamEndline &b)
PrintWriteroperator<< (const RPrintWriter &pp, const StreamEndline &b)
template<class T> void readBasicArray (BasicArray< T > *This, IN(::acdk::io::RObjectReader) in)
template<class T> void readObjectArray (ObjectArrayImpl< T > *This,::acdk::io::RObjectReader in)

Variables

enum SeekPos
enum ConsoleOutChannel
ACDK_CORE_PUBLIC StreamEndline endln

Typedef Documentation

typedef DataReader acdk::io::DataInput
 

typedef DataWriter acdk::io::DataOutput
 

typedef ObjectReader acdk::io::ObjectInput
 

typedef ObjectWriter acdk::io::ObjectOutput
 

typedef RDataReader acdk::io::RDataInput
 

typedef RDataWriter acdk::io::RDataOutput
 

typedef RObjectReader acdk::io::RObjectInput
 

typedef RObjectWriter acdk::io::RObjectOutput
 


Enumeration Type Documentation

enum acdk::io::ConsoleOutChannel
 

Channel of a console.

Enumeration values:
InvalidConsoleOutChannel  chanel is invalid/not set
CoutOutChannel 
CerrOutChannel 

enum acdk::io::FileInfoFlags
 

Information about file.

Enumeration values:
FileInfoExists  file exists or not This attribute is read only
FileInfoIsFile  file is a file This attribute is read only
FileInfoIsDir  file is a directory This attribute is read only
FileInfoCanRead  file can be read This attribute is read/write
FileInfoCanWrite  file can be written This attribute is read/write
FileInfoCanExec  file can be executed This attribute is read only on Windows
FileInfoIsHidden  File is hidden, either through hidden bit (win32) or a leading dot in file name (unix) on Unix read only.
FileInfoHasABit  DOS specific archive bit doesn't have any usage on non-win32 platforms.
FileInfoChecked  not used

enum acdk::io::FileListFlags
 

used in acdk::io::FileSystem

Enumeration values:
FileListFiles  list files
FileListDirectories 
FileListBoth  list files and directories
FileListRecursive  list files and/or directories recursivelly in sub directories.
FileListAllReadable  In case on error in list, resume with next directory.

Otherwise listing file will be aborted.

enum acdk::io::InChannel
 

helper enum for ConsoleReader

Enumeration values:
InvalidInChannel 
CinInChannel 

enum acdk::io::SeekPos
 

used by Reader::seek(SeekPos seekrel, jlong seekpos) to determine the seek direction

Enumeration values:
SeekCur  seek forward counting from current position
SeekEnd  seek counting backward from end position
SeekSet  seek counting forward from start position

enum acdk::io::SerializeFlags
 

a combination of SerializeFlags controls how to serialize in acdk::io::AbstractObjectWriter and acdk::io::AbstractObjectReader

Enumeration values:
SerializeNamed  Write the Class name of acdk::lang::Object into Stream.

This flag is needed, if read/writeObject will be used without given Class

SerializeTagged  Stream will structured by tags.

The Implemenation of ObjectWriter/Reader must implement the given writeTagStart() and writeTagEnd()

SerializeLabeled  The member fields of an class will be written with the fields names.
SerializeReduced  If cyclic object references in the acdk::lang::Object member exists, this flag advise to write the acdk::lang::Object reduced into the stream.

dublicated acdk::lang::Object instances will only written once.

SerializeJoinedStrings  String with the same content will be joined to one instance.

Will reduce file size, especially if also SerializeNamed or SerializeTagged or SerializeLabeled will be used. Does not make sense without SerializeReduced flag.

SerializeOnlySerializable  Only serialize the classes, which direcly implements the Serializable interface.

If this is not set, it will also serialize classes which indirectly implements Serializable

SerializeAll  Serialize all members, independed this class have implemented directly or inderectly the Serializable interface.
SerializeIgnoreNotSerializable  In connection with SerializeOnlySerializeable.

If an object not implemnting Serializable interface will be written, it simply writes Nil instead of throwing exception

SerializeCheckCompatVersion  check the SerialVersionUID of the class, if the classes are compatible or not.

Compatible serialization will only work, if SerializeNamed is used.

SerializeUseSerializedObjectDescriptor 
SerializeDefaultFlags 

Function Documentation

bool operator!= IN(RFileDescriptor f,
IN(RFileDescriptor s
[inline]
 

PrintWriter& operator<< const RPrintWriter pp,
const StreamEndline b
[inline]
 

PrintWriter& operator<< PrintWriter p,
const StreamEndline b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
char *  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
const char *  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
char *  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
const char *  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
double  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
float  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
jlong  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
int  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
short  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
byte  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
char  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
bool  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
double  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
float  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
jlong  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
int  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
short  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
byte  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
char  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
bool  b
[inline]
 

template<class T>
PrintWriter& operator<< RPrintWriter rp,
T *  b
[inline]
 

template<class T>
PrintWriter& operator<< PrintWriter p,
T *  b
[inline]
 

PrintWriter& operator<< RPrintWriter rp,
const RString b
[inline]
 

template<typename T>
PrintWriter& operator<< RPrintWriter rp,
const RefHolder< T > &  b
[inline]
 

PrintWriter& operator<< PrintWriter p,
const RString b
[inline]
 

template<typename T>
PrintWriter& operator<< PrintWriter p,
const RefHolder< T > &  b
[inline]
 

bool operator== IN(RFileDescriptor f,
IN(RFileDescriptor s
[inline]
 

template<class T>
void readBasicArray BasicArray< T > *  This,
IN(::acdk::io::RObjectReader in
 

template<class T>
void readObjectArray ObjectArrayImpl< T > *  This,
::acdk::io::RObjectReader  in
 


Variable Documentation

enum acdk::io::ConsoleOutChannel
 

ACDK_CORE_PUBLIC StreamEndline acdk::io::endln
 

enum acdk::io::SeekPos
 

 
Last modified 2005-05-08 18:32 by SYSTEM By Artefaktur, Ing. Bureau Kommer