public class DeferredFileOutputStream extends ThresholdingOutputStream
This class originated in FileUpload processing. In this use case, you do not know in advance the size of the file being uploaded. If the file is small you want to store it in memory (for speed), but if the file is large you want to store it to file (to avoid memory issues).
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.
|
DeferredFileOutputStream(int threshold,
int initialBufferSize,
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.
|
DeferredFileOutputStream(int threshold,
int initialBufferSize,
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.
|
DeferredFileOutputStream(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.
|
boolean |
isInMemory()
Determines whether or not the data for this output stream has been
retained in memory.
|
void |
writeTo(java.io.OutputStream out)
Writes the data from this output stream to the specified output stream,
after it has been closed.
|
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.public DeferredFileOutputStream(int threshold, int initialBufferSize, java.io.File outputFile)
threshold
- The number of bytes at which to trigger an event.initialBufferSize
- The initial size of the in memory buffer.outputFile
- The file to which data is saved beyond the threshold.public DeferredFileOutputStream(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.public DeferredFileOutputStream(int threshold, int initialBufferSize, java.lang.String prefix, java.lang.String suffix, java.io.File directory)
threshold
- The number of bytes at which to trigger an event.initialBufferSize
- The initial size of the in memory buffer.prefix
- Prefix to use for the temporary file.suffix
- Suffix to use for the temporary file.directory
- Temporary file directory.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()
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 ThresholdingOutputStream
java.io.IOException
- if an error occurs.public void writeTo(java.io.OutputStream out) throws java.io.IOException
out
- output stream to write to.java.io.IOException
- if this stream is not yet closed or an error occurs."Copyright © 2010 - 2020 Adobe Systems Incorporated. All Rights Reserved"