org.apache.tomcat.util.http.fileupload
public class DeferredFileOutputStream extends ThresholdingOutputStream
An output stream which will retain data in memory until a specified threshold is reached, and only then commit it to disk. If the stream is closed before the threshold is reached, the data will not be written to disk at all.
Constructor and Description |
---|
DeferredFileOutputStream(int threshold,
java.io.File outputFile)
Constructs an instance of this class which will trigger an event at the
specified threshold, and save data to a file beyond that point.
|
Modifier and Type | Method and Description |
---|---|
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 the data for this output stream as a
File , assuming
that the data was written to disk. |
protected java.io.OutputStream |
getStream()
Returns the current output stream.
|
boolean |
isInMemory()
Determines whether or not the data for this output stream has been
retained in memory.
|
protected void |
thresholdReached()
Switches the underlying output stream from a memory based stream to one
that is backed by disk.
|
checkThreshold, close, flush, getByteCount, getThreshold, isThresholdExceeded, write, write, write
public DeferredFileOutputStream(int threshold, java.io.File outputFile)
threshold
- The number of bytes at which to trigger an event.outputFile
- The file to which data is saved beyond the threshold.protected java.io.OutputStream getStream() throws java.io.IOException
getStream
in class ThresholdingOutputStream
java.io.IOException
- if an error occurs.protected void thresholdReached() throws java.io.IOException
thresholdReached
in class ThresholdingOutputStream
java.io.IOException
- if an error occurs.public boolean isInMemory()
true
if the data is available in memory;
false
otherwise.public byte[] getData()
null
.null
if no such
data is available.public java.io.File getFile()
File
, assuming
that the data was written to disk. If the data was retained in memory,
this method returns null
.null
if no such
file exists.Copyright © 2000-2013 Apache Software Foundation. All Rights Reserved.