Home » apache-tomcat-6.0.26-src » org.apache » tomcat » util » http » fileupload » [javadoc | source]
public class: DeferredFileOutputStream [javadoc | source]

All Implemented Interfaces:
    Closeable, Flushable

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.

 public DeferredFileOutputStream(int threshold,
    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.
    threshold - The number of bytes at which to trigger an event.
    outputFile - The file to which data is saved beyond the threshold.
Method from org.apache.tomcat.util.http.fileupload.DeferredFileOutputStream Summary:
getData,   getFile,   getStream,   isInMemory,   thresholdReached
Methods from org.apache.tomcat.util.http.fileupload.ThresholdingOutputStream:
checkThreshold,   close,   flush,   getByteCount,   getStream,   getThreshold,   isThresholdExceeded,   thresholdReached,   write,   write,   write
Methods from java.io.OutputStream:
close,   flush,   write,   write,   write
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.tomcat.util.http.fileupload.DeferredFileOutputStream Detail:
 public byte[] getData() 
    Returns the data for this output stream as an array of bytes, assuming that the data has been retained in memory. If the data was written to disk, this method returns null.
 public File getFile() 
    Returns the data for this output stream as a File, assuming that the data was written to disk. If the data was retained in memory, this method returns null.
 protected OutputStream getStream() throws IOException 
    Returns the current output stream. This may be memory based or disk based, depending on the current state with respect to the threshold.
 public boolean isInMemory() 
    Determines whether or not the data for this output stream has been retained in memory.
 protected  void thresholdReached() throws IOException 
    Switches the underlying output stream from a memory based stream to one that is backed by disk. This is the point at which we realise that too much data is being written to keep in memory, so we elect to switch to disk-based storage.