@Beta @GwtIncompatible public final class FileBackedOutputStream extends java.io.OutputStream
OutputStream
that starts buffering to a byte array, but switches to file buffering
once the data reaches a configurable size.
Temporary files created by this stream may live in the local filesystem until either:
reset()
is called (removing the data in this stream and deleting the file), or...
asByteSource()
view) is finalized during
garbage collection, AND this stream was not constructed with the 1-arg constructor or the 2-arg constructor passing false
in the
second parameter.
This class is thread-safe.
Constructor and Description |
---|
FileBackedOutputStream(int fileThreshold)
Creates a new instance that uses the given file threshold, and does not reset the data when the
ByteSource returned by asByteSource() is finalized. |
FileBackedOutputStream(int fileThreshold,
boolean resetOnFinalize)
Creates a new instance that uses the given file threshold, and optionally resets the data when
the
ByteSource returned by asByteSource() is finalized. |
Modifier and Type | Method and Description |
---|---|
ByteSource |
asByteSource()
Returns a readable
ByteSource view of the data that has been written to this stream. |
void |
close() |
void |
flush() |
void |
reset()
Calls
close() if not already closed, and then resets this object back to its initial
state, for reuse. |
void |
write(byte[] b) |
void |
write(byte[] b,
int off,
int len) |
void |
write(int b) |
public FileBackedOutputStream(int fileThreshold)
ByteSource
returned by asByteSource()
is finalized.fileThreshold
- the number of bytes before the stream should switch to buffering to a filepublic FileBackedOutputStream(int fileThreshold, boolean resetOnFinalize)
ByteSource
returned by asByteSource()
is finalized.fileThreshold
- the number of bytes before the stream should switch to buffering to a fileresetOnFinalize
- if true, the reset()
method will be called when the ByteSource
returned by asByteSource()
is finalized.public ByteSource asByteSource()
ByteSource
view of the data that has been written to this stream.public void reset() throws java.io.IOException
close()
if not already closed, and then resets this object back to its initial
state, for reuse. If data was buffered to a file, it will be deleted.java.io.IOException
- if an I/O error occurred while deleting the file bufferpublic void write(int b) throws java.io.IOException
write
in class java.io.OutputStream
java.io.IOException
public void write(byte[] b) throws java.io.IOException
write
in class java.io.OutputStream
java.io.IOException
public void write(byte[] b, int off, int len) throws java.io.IOException
write
in class java.io.OutputStream
java.io.IOException
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in class java.io.OutputStream
java.io.IOException
public void flush() throws java.io.IOException
flush
in interface java.io.Flushable
flush
in class java.io.OutputStream
java.io.IOException
Copyright © 2010–2021 JBoss by Red Hat. All rights reserved.