Package org.opendaylight.raft.spi

Class SharedFileBackedOutputStream

java.lang.Object

java.io.OutputStream

org.opendaylight.raft.spi.FileBackedOutputStream

org.opendaylight.raft.spi.SharedFileBackedOutputStream

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class SharedFileBackedOutputStream
extends FileBackedOutputStream

A FileBackedOutputStream that allows for sharing in that it maintains a usage count and the backing file isn't deleted until the usage count reaches 0. The usage count is initialized to 1 on construction. Subsequent users of the instance must call incrementUsageCount(). The cleanup() method decrements the usage count and, when it reaches 0, the FileBackedOutputStream.cleanup() is called to delete the backing file.

Author:

Thomas Pantelis

Nested Class Summary

Nested classes/interfaces inherited from class org.opendaylight.raft.spi.FileBackedOutputStream

FileBackedOutputStream.Configuration

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	cleanup()	Overridden to decrement the usage count.
int	getUsageCount()	Returns the current usage count.
void	incrementUsageCount()	Increments the usage count.
void	setOnCleanupCallback(Runnable callback)	Sets the callback to be notified when FileBackedOutputStream.cleanup() is called to delete the backing file.

Methods inherited from class org.opendaylight.raft.spi.FileBackedOutputStream

close, flush, getCount, toStreamSource, write, write, write

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

SharedFileBackedOutputStream

public SharedFileBackedOutputStream(FileBackedOutputStream.Configuration config)

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

Parameters:

config - the configuration.

Method Details

incrementUsageCount

public void incrementUsageCount()

Increments the usage count. This must be followed by a corresponding call to cleanup() when this instance is no longer needed.

getUsageCount

public int getUsageCount()

Returns the current usage count.

Returns:

the current usage count

setOnCleanupCallback

public void setOnCleanupCallback(Runnable callback)

Sets the callback to be notified when FileBackedOutputStream.cleanup() is called to delete the backing file.

Parameters:

callback - the callback

cleanup

public void cleanup()

Overridden to decrement the usage count.

Overrides:

cleanup in class FileBackedOutputStream