org.subethamail.smtp.internal.io

Class DeferredFileOutputStream

java.lang.Object

java.io.OutputStream

org.subethamail.smtp.internal.io.DeferredFileOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class DeferredFileOutputStream
extends OutputStream

This works like a ByteArrayOutputStream until a certain size is reached, then creates a temp file and acts like a buffered FileOutputStream. The data can be retreived afterwards by calling getInputStream(). When this object is closed, the temporary file is deleted. You can no longer call getInputStream().

Author:

Jeff Schnitzer

Field Summary

Fields

Modifier and Type	Field and Description
protected OutputStream	output
static String	TMPFILE_PREFIX
static String	TMPFILE_SUFFIX

Constructor Summary

Constructors

Constructor and Description
DeferredFileOutputStream(int transitionSize)

Method Summary

Modifier and Type	Method and Description
protected void	checkThreshold(int count) Checks whether reading count bytes would cross the limit.
void	close()
void	flush()
InputStream	getInputStream() Closes the output stream and creates an InputStream on the same data.
protected void	thresholdReached(int current, int predicted) Called when the threshold is about to be exceeded.
void	write(byte[] b)
void	write(byte[] b, int off, int len)
void	write(int b)

Methods inherited from class java.lang.Object

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

Field Detail

TMPFILE_PREFIX

public static final String TMPFILE_PREFIX

See Also:

Constant Field Values

TMPFILE_SUFFIX

public static final String TMPFILE_SUFFIX

See Also:

Constant Field Values

output

protected OutputStream output

Constructor Detail

DeferredFileOutputStream

public DeferredFileOutputStream(int transitionSize)

Parameters:

transitionSize - is the number of bytes at which to convert from a byte array to a real file.

Method Detail

thresholdReached

protected void thresholdReached(int current,
                                int predicted)
                         throws IOException

Called when the threshold is about to be exceeded. This isn't exact; it's called whenever a write would occur that would cross the amount. Once it is called, it isn't called again.

Parameters:

current - is the current number of bytes that have been written

predicted - is the total number after the write completes

Throws:

IOException

getInputStream

public InputStream getInputStream()
                           throws IOException

Closes the output stream and creates an InputStream on the same data.

Returns:

either a BetterByteArrayOutputStream or buffered FileInputStream, depending on what state we are in.

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

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(byte[] b)
           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

checkThreshold

protected void checkThreshold(int count)
                       throws IOException

Checks whether reading count bytes would cross the limit.

Throws:

IOException