org.rocksdb

Class AbstractImmutableNativeReference

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

All Implemented Interfaces:

java.lang.AutoCloseable

Direct Known Subclasses:

RocksCallbackObject, RocksObject

public abstract class AbstractImmutableNativeReference
extends AbstractNativeReference

Offers functionality for implementations of AbstractNativeReference which have an immutable reference to the underlying native C++ object

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractImmutableNativeReference(boolean owningHandle)

Method Summary

Modifier and Type	Method and Description
void	close() Frees the underlying C++ object
protected void	disOwnNativeHandle() Releases this AbstractNativeReference from the responsibility of freeing the underlying native C++ object
protected abstract void	disposeInternal() The helper function of AbstractNativeReference.dispose() which all subclasses of AbstractImmutableNativeReference must implement to release their underlying native C++ objects.
boolean	isOwningHandle() Returns true if we are responsible for freeing the underlying C++ object

Methods inherited from class org.rocksdb.AbstractNativeReference

dispose, finalize

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractImmutableNativeReference

protected AbstractImmutableNativeReference(boolean owningHandle)

Method Detail

isOwningHandle

public boolean isOwningHandle()

Description copied from class: AbstractNativeReference

Returns true if we are responsible for freeing the underlying C++ object

Specified by:

isOwningHandle in class AbstractNativeReference

Returns:

true if we are responsible to free the C++ object

See Also:

AbstractNativeReference.dispose()

disOwnNativeHandle

protected final void disOwnNativeHandle()

Releases this AbstractNativeReference from the responsibility of freeing the underlying native C++ object

This will prevent the object from attempting to delete the underlying native object in its finalizer. This must be used when another object takes over ownership of the native object or both will attempt to delete the underlying object when garbage collected.

When disOwnNativeHandle() is called, dispose() will subsequently take no action. As a result, incorrect use of this function may cause a memory leak.

See Also:

AbstractNativeReference.dispose()

close

public void close()

Description copied from class: AbstractNativeReference

Frees the underlying C++ object

It is strong recommended that the developer calls this after they have finished using the object.

Note, that once an instance of AbstractNativeReference has been disposed, calling any of its functions will lead to undefined behavior.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class AbstractNativeReference

disposeInternal

protected abstract void disposeInternal()

The helper function of AbstractNativeReference.dispose() which all subclasses of AbstractImmutableNativeReference must implement to release their underlying native C++ objects.