Package org.codehaus.plexus.archiver.zip
Class OffloadingOutputStream
java.lang.Object
java.io.OutputStream
org.apache.commons.io.output.ThresholdingOutputStream
org.codehaus.plexus.archiver.zip.OffloadingOutputStream
- All Implemented Interfaces:
Closeable
,Flushable
,AutoCloseable
class OffloadingOutputStream
extends org.apache.commons.io.output.ThresholdingOutputStream
Offloads to disk when a given memory consumption has been reacehd
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
True when close() has been called successfully.private OutputStream
The output stream to which data will be written at any given time.private final File
The directory to use for temporary files.private ByteArrayOutputStream
The output stream to which data will be written prior to the theshold being reached.private File
The file to which output will be directed if the threshold is exceeded.private final String
The temporary file prefix.private final String
The temporary file suffix. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
OffloadingOutputStream
(int threshold, File outputFile, String prefix, String suffix, 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, String prefix, String suffix, 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. -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Closes underlying output stream, and mark this as closedbyte[]
getData()
Returns the data for this output stream as an array of bytes, assuming that the data has been retained in memory.getFile()
Returns either the output file specified in the constructor or the temporary file created or null.protected OutputStream
Returns the current output stream.protected void
Switches the underlying output stream from a memory based stream to one that is backed by disk.Methods inherited from class org.apache.commons.io.output.ThresholdingOutputStream
checkThreshold, flush, getByteCount, getThreshold, isThresholdExceeded, resetByteCount, setByteCount, write, write, write
Methods inherited from class java.io.OutputStream
nullOutputStream
-
Field Details
-
memoryOutputStream
The output stream to which data will be written prior to the theshold being reached. -
currentOutputStream
The output stream to which data will be written at any given time. This will always be one ofmemoryOutputStream
ordiskOutputStream
. -
outputFile
The file to which output will be directed if the threshold is exceeded. -
prefix
The temporary file prefix. -
suffix
The temporary file suffix. -
directory
The directory to use for temporary files. -
closed
private boolean closedTrue when close() has been called successfully.
-
-
Constructor Details
-
OffloadingOutputStream
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.- Parameters:
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.- Since:
- 1.4
-
OffloadingOutputStream
private OffloadingOutputStream(int threshold, File outputFile, String prefix, String suffix, 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.- Parameters:
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.
-
-
Method Details
-
getStream
Returns the current output stream. This may be memory based or disk based, depending on the current state with respect to the threshold.- Specified by:
getStream
in classorg.apache.commons.io.output.ThresholdingOutputStream
- Returns:
- The underlying output stream.
- Throws:
IOException
- if an error occurs.
-
thresholdReached
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.- Specified by:
thresholdReached
in classorg.apache.commons.io.output.ThresholdingOutputStream
- Throws:
IOException
- if an error occurs.
-
getInputStream
- Throws:
IOException
-
getData
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 returnsnull
.- Returns:
- The data for this output stream, or
null
if no such data is available.
-
getFile
Returns either the output file specified in the constructor or the temporary file created or null.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.- Returns:
- The file for this output stream, or
null
if no such file exists.
-
close
Closes underlying output stream, and mark this as closed- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classorg.apache.commons.io.output.ThresholdingOutputStream
- Throws:
IOException
- if an error occurs.
-