Package org.backsource.utils.io

Stuff to work with io.

See:
Description

Interface Summary

CachedStream

Helper class to work with cached streams.

Class Summary

ByteCachedInputStream	This is an InputStream that reads from cached data it will get from a CachedOutputStream.
ByteCachedOutputStream	A CachedOutoutStream.
ByteCachedStream	A CachedStream that returnes streams that are cached in memory in a byte array.
ByteCachedStreamFactory	A factory that produces a CachedStream with streams that are cached in memory in a byte array.
CachedInputStream	This is an InputStream that reads from cached data it will get from a CachedOutputStream.
CachedOutputStream	A CachedOutoutStream.
CachedStreamFactory	Factory for CachedStream implementation.
DevNullOutputStream	DevNullOutpuStream send data to nowhere.
DOMCachedInputStream	A cached input stream that reads from a DOMInputStream.
DOMCachedOutputStream	A cached stream that uses a DOMOutputStream.
DOMCachedStream	A StreamCache that caches data in a DOM Document.
DOMCachedStreamFactory	A factory that produces a CachedStream with streams that are cached in a DOM Document.
DOMInputStream	A stream that reads from a DOM Document (much like a FileInputStream reads from a file).
DOMOutputStream	Write to a DOM Document.
DotLock	Simple, portable file locking using .lock files.
FileCachedInputStream	Cached input stream that reads from a possibly temp file.
FileCachedOutputStream	Stream that writes to a file.
FileCachedStream	A StreamCache that cached data in temporary files.
FileCachedStreamFactory	A factory that produces a CachedStream with streams that are cached in temporary files.
IOHelper	A simple IO helper that has bean arround some time.
ReaderInputStream	An InputStream of of a Reader, which might no allways work.

Package org.backsource.utils.io Description

Stuff to work with io.

The IOHelper might be handy sometimes when you just need to get a Reader or InputStream to write to a Writer or OutputStream.

The DOM stream pair (DOMInputStream and DOMOutputStream) is a couple of handy streams to use with XML. With the DOMInputStream it is possible to construct a stream that reads directly from a DOM Document without having to serialize it to some output first; with the DOMOutputStream it is possible to write directly to a DOM Document.

Cached Stream

The CachedStream API is constructed with two pusposses in mind:

• To make it easy to work with reusable stream; i.e where you are going to read from the same stream multiple times: CachedStream
• To make it configurable which caching strategy to use: CachedStreamFactory.

There are several implementations to chose from: for small files the in memory based: ByteCachedStream, for large files that would drain memory: FileCachedStream and for XML files: DOMCachedStream.