to.etc.util

Class FileBackedBuffer

java.lang.Object

java.io.OutputStream

to.etc.util.FileBackedBuffer

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class FileBackedBuffer
extends OutputStream

A buffer which accepts data and buffers it. The data can be obtained again by reading an input stream. If the data grows too large (user definable) it can flush the data into a tempfile. This class is not threadsafe of course.

Because this class may retain a file it is important that it gets cleaned up after use by calling discard().

Author:

Frits Jalvingh Created on Aug 10, 2006

Constructor Summary

Constructors

Constructor and Description
FileBackedBuffer()
FileBackedBuffer(int size)
FileBackedBuffer(int size, int initial)

Method Summary

Modifier and Type	Method and Description
File	asFile()
void	clear() Removes all contents from this thingy, and reopens it as an output stream.
void	close() This closes the write channel.
void	copy(OutputStream os) Sends all of the contained data to the outputstream.
void	discard() This MUST be called after use.
protected void	finalize() This finalizer at least tries to cleanup the mess if discard() was not called...
InputStream	getInputStream() Returns an inputstream which reads this.
int	size()
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileBackedBuffer

public FileBackedBuffer()

FileBackedBuffer

public FileBackedBuffer(int size)

FileBackedBuffer

public FileBackedBuffer(int size,
                        int initial)

Method Detail

discard

public void discard()

This MUST be called after use. It releases all resources held by this object.

finalize

protected void finalize()
                 throws Throwable

This finalizer at least tries to cleanup the mess if discard() was not called...

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

close

public void close()
           throws IOException

This closes the write channel. After this the data can be read using getInputStream() or another call.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

See Also:

OutputStream.close()

asFile

public File asFile()
            throws IOException

Throws:

IOException

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

clear

public void clear()

Removes all contents from this thingy, and reopens it as an output stream.

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an inputstream which reads this. This always returns the same stream instance(!) so it cannot be called >1ce while the previous stream is still open. If you do you'll get exceptioned.

Throws:

IOException

size

public int size()

copy

public void copy(OutputStream os)
          throws IOException

Sends all of the contained data to the outputstream.

Parameters:

os -

Throws:

IOException