Package org.opendaylight.raft.spi

Class FileBackedOutputStream

java.lang.Object

java.io.OutputStream

org.opendaylight.raft.spi.FileBackedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

SharedFileBackedOutputStream

public 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.

Author:

Thomas Pantelis

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	FileBackedOutputStream.Configuration	Configuration for FileBackedOutputStream.

Constructor Summary

Constructors

Constructor	Description
FileBackedOutputStream(FileBackedOutputStream.Configuration config)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Calls close() if not already closed and, if data was buffered to a file, deletes the file.
void	close()
void	flush()
long	getCount()	Returns current byte size.
@NonNull SizedStreamSource	toStreamSource()	Returns a readable SizedStreamSource view of the data that has been written to this stream.
void	write(byte[] bytes)
void	write(byte[] bytes, int off, int len)
void	write(int value)

Methods inherited from class java.io.OutputStream

nullOutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FileBackedOutputStream

public FileBackedOutputStream(FileBackedOutputStream.Configuration config)

Default constructor. Resulting instance uses the given file threshold, and does not reset the data when the SizedStreamSource returned by toStreamSource() is finalized.

Parameters:

config - the FileBackedOutputStream.Configuration to use

Method Details

toStreamSource

public @NonNull SizedStreamSource toStreamSource()
                                          throws IOException

Returns a readable SizedStreamSource view of the data that has been written to this stream. This stream is closed and further attempts to write to it will result in an IOException.

Returns:

a SizedStreamSource instance

Throws:

IOException - if close fails

write

public void write(int value)
           throws IOException

Specified by:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

write

public void write(byte[] bytes,
 int off,
 int len)
           throws IOException

Overrides:

write in class OutputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class OutputStream

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Overrides:

flush in class OutputStream

Throws:

IOException

getCount

public long getCount()

Returns current byte size.

Returns:

current byte size

cleanup

public void cleanup()

Calls close() if not already closed and, if data was buffered to a file, deletes the file.