class OffloadingOutputStream
extends org.apache.commons.io.output.ThresholdingOutputStream
Modifier and Type | Field and Description |
---|---|
private boolean |
closed
True when close() has been called successfully.
|
private java.io.OutputStream |
currentOutputStream
The output stream to which data will be written at any given time.
|
private java.io.File |
directory
The directory to use for temporary files.
|
private ByteArrayOutputStream |
memoryOutputStream
The output stream to which data will be written prior to the theshold
being reached.
|
private java.io.File |
outputFile
The file to which output will be directed if the threshold is exceeded.
|
private java.lang.String |
prefix
The temporary file prefix.
|
private java.lang.String |
suffix
The temporary file suffix.
|
Modifier | Constructor and Description |
---|---|
private |
OffloadingOutputStream(int threshold,
java.io.File outputFile,
java.lang.String prefix,
java.lang.String suffix,
java.io.File directory)
Constructs an instance of this class which will trigger an event at the
specified threshold, and save data either to a file beyond that point.
|
|
OffloadingOutputStream(int threshold,
java.lang.String prefix,
java.lang.String suffix,
java.io.File directory)
Constructs an instance of this class which will trigger an event at the
specified threshold, and save data to a temporary file beyond that point.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Closes underlying output stream, and mark this as closed
|
byte[] |
getData()
Returns the data for this output stream as an array of bytes, assuming
that the data has been retained in memory.
|
java.io.File |
getFile()
Returns either the output file specified in the constructor or
the temporary file created or null.
|
java.io.InputStream |
getInputStream() |
protected java.io.OutputStream |
getStream()
Returns the current output stream.
|
protected void |
thresholdReached()
Switches the underlying output stream from a memory based stream to one
that is backed by disk.
|
private ByteArrayOutputStream memoryOutputStream
private java.io.OutputStream currentOutputStream
memoryOutputStream
or
diskOutputStream
.private java.io.File outputFile
private final java.lang.String prefix
private final java.lang.String suffix
private final java.io.File directory
private boolean closed
public OffloadingOutputStream(int threshold, java.lang.String prefix, java.lang.String suffix, java.io.File directory)
threshold
- The number of bytes at which to trigger an event.prefix
- Prefix to use for the temporary file.suffix
- Suffix to use for the temporary file.directory
- Temporary file directory.private OffloadingOutputStream(int threshold, java.io.File outputFile, java.lang.String prefix, java.lang.String suffix, java.io.File directory)
threshold
- The number of bytes at which to trigger an event.outputFile
- The file to which data is saved beyond the threshold.prefix
- Prefix to use for the temporary file.suffix
- Suffix to use for the temporary file.directory
- Temporary file directory.protected java.io.OutputStream getStream() throws java.io.IOException
getStream
in class org.apache.commons.io.output.ThresholdingOutputStream
java.io.IOException
- if an error occurs.protected void thresholdReached() throws java.io.IOException
thresholdReached
in class org.apache.commons.io.output.ThresholdingOutputStream
java.io.IOException
- if an error occurs.public java.io.InputStream getInputStream() throws java.io.IOException
java.io.IOException
public byte[] getData()
null
.null
if no such
data is available.public java.io.File getFile()
If the constructor specifying the file is used then it returns that same output file, even when threshold has not been reached.
If constructor specifying a temporary file prefix/suffix is used
then the temporary file created once the threshold is reached is returned
If the threshold was not reached then null
is returned.
null
if no such
file exists.public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in class org.apache.commons.io.output.ThresholdingOutputStream
java.io.IOException
- if an error occurs.