javadoc.com.google.common.io.FileBackedOutputStream.html Maven / Gradle / Ivy
The newest version!
FileBackedOutputStream (Guava: Google Core Libraries for Java 11.0.1 API)
Overview
Package
Class
Use
Tree
Deprecated
Index
Help
PREV CLASS
NEXT CLASS
FRAMES
NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD
DETAIL: FIELD | CONSTR | METHOD
com.google.common.io
Class FileBackedOutputStream
java.lang.Object
java.io.OutputStream
com.google.common.io.FileBackedOutputStream
@Beta
public final class FileBackedOutputStream
- extends OutputStream
An OutputStream
that starts buffering to a byte array, but
switches to file buffering once the data reaches a configurable size.
This class is thread-safe.
- Since:
- 1.0
- Author:
- Chris Nokleberg
Constructor Summary | |
---|---|
FileBackedOutputStream(int fileThreshold)
Creates a new instance that uses the given file threshold, and does not reset the data when the InputSupplier returned by
getSupplier() is finalized. |
|
FileBackedOutputStream(int fileThreshold,
boolean resetOnFinalize)
Creates a new instance that uses the given file threshold, and optionally resets the data when the InputSupplier returned
by getSupplier() is finalized. |
Method Summary | |
---|---|
void |
close()
|
void |
flush()
|
InputSupplier<InputStream> |
getSupplier()
Returns a supplier that may be used to retrieve the data buffered by this stream. |
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)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
FileBackedOutputStream
public FileBackedOutputStream(int fileThreshold)
- Creates a new instance that uses the given file threshold, and does
not reset the data when the
InputSupplier
returned bygetSupplier()
is finalized.- Parameters:
fileThreshold
- the number of bytes before the stream should switch to buffering to a file
FileBackedOutputStream
public FileBackedOutputStream(int fileThreshold, boolean resetOnFinalize)
- Creates a new instance that uses the given file threshold, and
optionally resets the data when the
InputSupplier
returned bygetSupplier()
is finalized.- Parameters:
fileThreshold
- the number of bytes before the stream should switch to buffering to a fileresetOnFinalize
- if true, thereset()
method will be called when theInputSupplier
returned bygetSupplier()
is finalized
Method Detail |
---|
getSupplier
public InputSupplier<InputStream> getSupplier()
- Returns a supplier that may be used to retrieve the data buffered
by this stream.
reset
public void reset() throws IOException
- Calls
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.- Throws:
IOException
- if an I/O error occurred while deleting the file buffer
write
public void write(int b) throws IOException
- Specified by:
write
in classOutputStream
- Throws:
IOException
write
public void write(byte[] b) throws IOException
- Overrides:
write
in classOutputStream
- Throws:
IOException
write
public void write(byte[] b, int off, int len) throws IOException
- Overrides:
write
in classOutputStream
- Throws:
IOException
close
public void close() throws IOException
- Specified by:
close
in interfaceCloseable
- Overrides:
close
in classOutputStream
- Throws:
IOException
flush
public void flush() throws IOException
- Specified by:
flush
in interfaceFlushable
- Overrides:
flush
in classOutputStream
- Throws:
IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright © 2010-2012. All Rights Reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy