org.n52.javaps.utils

Class LargeBufferStream

java.lang.Object

java.io.OutputStream

org.n52.javaps.utils.LargeBufferStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class LargeBufferStream
extends OutputStream

A fully buffered output stream using local disk storage for large data.

Initially this output stream buffers to memory, like ByteArrayOutputStream might do, but it shifts to using an on disk temporary file if the output gets too large.

The content of this buffered stream may be sent to another OutputStream only after this stream has been properly closed by close().

Constructor Summary

Constructors

Constructor and Description
LargeBufferStream() Create a new empty temporary buffer.

Method Summary

Modifier and Type	Method and Description
void	close()
void	destroy() Clear this buffer so it has no data, and cannot be used again.
long	length() Obtain the length (in bytes) of the buffer.
void	write(byte[] b, int off, int len)
void	write(int b)
void	writeTo(OutputStream os) Send this buffer to an output stream.

Methods inherited from class java.io.OutputStream

flush, write

Methods inherited from class java.lang.Object

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

Constructor Detail

LargeBufferStream

public LargeBufferStream()

Create a new empty temporary buffer.

Method Detail

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

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

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class OutputStream

Throws:

IOException

length

public long length()

Obtain the length (in bytes) of the buffer.

The length is only accurate after close() has been invoked.

Returns:

total length of the buffer, in bytes.

writeTo

public void writeTo(OutputStream os)
             throws IOException

Send this buffer to an output stream.

This method may only be invoked after close() has completed normally, to ensure all data is completely transferred.

Parameters:

os - stream to send this buffer's complete content to.

Throws:

IOException - an error occurred reading from a temporary file on the local system, or writing to the output stream.

destroy

public void destroy()

Clear this buffer so it has no data, and cannot be used again.