io.permazen.kv.util

Class CloseableForwardingKVStore

java.lang.Object

io.permazen.kv.util.ForwardingKVStore

io.permazen.kv.util.CloseableForwardingKVStore

All Implemented Interfaces:

CloseableKVStore, KVStore, Closeable, AutoCloseable

Direct Known Subclasses:

CachingKVStore

public class CloseableForwardingKVStore
extends ForwardingKVStore
implements CloseableKVStore

A ForwardingKVStore also implementing CloseableKVStore, with some associated underlying Closeable resource to close when close()'d.

Constructor Summary

Constructors

Constructor and Description
CloseableForwardingKVStore(CloseableKVStore kvstore) Convenience constructor.
CloseableForwardingKVStore(KVStore kvstore) Constructor for a do-nothing close().
CloseableForwardingKVStore(KVStore kvstore, Closeable resource) Primary constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Close this KVStore and release any resources associated with it.
protected KVStore	delegate() Get the underlying KVStore.
protected void	finalize() Ensure the associated resource is close()'d before reclaiming memory.

Methods inherited from class io.permazen.kv.util.ForwardingKVStore

adjustCounter, apply, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, put, remove, removeRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.permazen.kv.KVStore

adjustCounter, apply, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, getRange, getRange, put, remove, removeRange, removeRange

Constructor Detail

CloseableForwardingKVStore

public CloseableForwardingKVStore(KVStore kvstore)

Constructor for a do-nothing close().

With this constructor, nothing will actually be closed when close() is invoked.

Parameters:

kvstore - key/value store for forwarding

Throws:

IllegalArgumentException - if kvstore is null

CloseableForwardingKVStore

public CloseableForwardingKVStore(CloseableKVStore kvstore)

Convenience constructor.

Parameters:

kvstore - key/value store for forwarding; will be closed on close()

Throws:

IllegalArgumentException - if kvstore is null

CloseableForwardingKVStore

public CloseableForwardingKVStore(KVStore kvstore,
                                  Closeable resource)

Primary constructor.

Parameters:

kvstore - key/value store for forwarding

resource - Closeable resource, or null for none

Throws:

IllegalArgumentException - if kvstore is null

Method Detail

delegate

protected KVStore delegate()

Description copied from class: ForwardingKVStore

Get the underlying KVStore.

Specified by:

delegate in class ForwardingKVStore

Returns:

underlying KVStore

close

public void close()

Description copied from interface: CloseableKVStore

Close this KVStore and release any resources associated with it.

If this instance is already closed, then nothing happens.

Specified by:

close in interface CloseableKVStore

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()
                 throws Throwable

Ensure the associated resource is close()'d before reclaiming memory.

Overrides:

finalize in class Object

Throws:

Throwable