]> git.proxmox.com Git - ceph.git/blobdiff - ceph/src/rocksdb/java/src/main/java/org/rocksdb/RocksObject.java
add subtree-ish sources for 12.0.3
[ceph.git] / ceph / src / rocksdb / java / src / main / java / org / rocksdb / RocksObject.java
diff --git a/ceph/src/rocksdb/java/src/main/java/org/rocksdb/RocksObject.java b/ceph/src/rocksdb/java/src/main/java/org/rocksdb/RocksObject.java
new file mode 100644 (file)
index 0000000..2a35852
--- /dev/null
@@ -0,0 +1,41 @@
+// Copyright (c) 2011-present, Facebook, Inc.  All rights reserved.
+// This source code is licensed under the BSD-style license found in the
+// LICENSE file in the root directory of this source tree. An additional grant
+// of patent rights can be found in the PATENTS file in the same directory.
+
+package org.rocksdb;
+
+/**
+ * RocksObject is an implementation of {@link AbstractNativeReference} which
+ * has an immutable and therefore thread-safe reference to the underlying
+ * native C++ RocksDB object.
+ * <p>
+ * RocksObject is the base-class of almost all RocksDB classes that have a
+ * pointer to some underlying native C++ {@code rocksdb} object.</p>
+ * <p>
+ * The use of {@code RocksObject} should always be preferred over
+ * {@link RocksMutableObject}.</p>
+ */
+public abstract class RocksObject extends AbstractImmutableNativeReference {
+
+  /**
+   * An immutable reference to the value of the C++ pointer pointing to some
+   * underlying native RocksDB C++ object.
+   */
+  protected final long nativeHandle_;
+
+  protected RocksObject(final long nativeHandle) {
+    super(true);
+    this.nativeHandle_ = nativeHandle;
+  }
+
+  /**
+   * Deletes underlying C++ object pointer.
+   */
+  @Override
+  protected void disposeInternal() {
+    disposeInternal(nativeHandle_);
+  }
+
+  protected abstract void disposeInternal(final long handle);
+}