Class FileBackedOutputStream

java.lang.Object

java.io.OutputStream

net.bluemind.common.io.FileBackedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class FileBackedOutputStream
extends OutputStream

An OutputStream that starts buffering to a byte array, but switches to file buffering once the data reaches a configurable size.

This class is thread-safe.

Since:

1.0

Author:

Chris Nokleberg

Constructor Summary

Constructors

Constructor	Description
FileBackedOutputStream(int fileThreshold, int sizeHint, String filenamePrefix)	Creates a new instance that uses the given file threshold, and does not reset the data when the ByteSource returned by asByteSource() is finalized.
FileBackedOutputStream(int fileThreshold, String filenamePrefix)	Creates a new instance that uses the given file threshold, and does not reset the data when the ByteSource returned by asByteSource() is finalized.

Method Summary

Modifier and Type	Method	Description
com.google.common.io.ByteSource	asByteSource()	Returns a readable ByteSource view of the data that has been written to this stream.
void	close()
protected void	finalize()
void	flush()
void	reset()	Calls close() if not already closed, and then resets this object back to its initial state, for reuse.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class OutputStream

nullOutputStream

Methods inherited from class Object

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

Constructor Details

FileBackedOutputStream

public FileBackedOutputStream(int fileThreshold,
 String filenamePrefix)

Creates a new instance that uses the given file threshold, and does not reset the data when the ByteSource returned by asByteSource() is finalized.

Parameters:

fileThreshold - the number of bytes before the stream should switch to buffering to a file

filenamePrefix - name hint for the optional temporary file

FileBackedOutputStream

public FileBackedOutputStream(int fileThreshold,
 int sizeHint,
 String filenamePrefix)

Creates a new instance that uses the given file threshold, and does not reset the data when the ByteSource returned by asByteSource() is finalized.

Parameters:

fileThreshold - the number of bytes before the stream should switch to buffering to a file. Not smaller than core.io.write-buffer

sizeHint - if size store is known in advance

filenamePrefix - name hint for the optional temporary file

Method Details

asByteSource

public com.google.common.io.ByteSource asByteSource()

Returns a readable ByteSource view of the data that has been written to this stream.

Since:

15.0

reset

public void reset()
           throws IOException

Calls close() if not already closed, and then resets this object back to its initial state, for reuse. If data was buffered to a file, it will be deleted.

Throws:

IOException - if an I/O error occurred while deleting the file buffer

write

public void write(int b)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] b)
           throws IOException

Overrides:

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 AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable