[REVIEW][Java] Rename destroyIndex() to close(), extend AutoCloseable (#1252)

The various `Index` classes in Java all have a `destroyIndex` method that must be called in order to free resources associated with that index, when done.
Other classes in the repository use `close()` instead, and extend or implement `AutoCloseable`; this have the advantage of support in language (try-with-resources) and tooling (e.g. IntelliJ warnings).
Additionally, having a single pattern is better for ease of use and consistency.

This PR renames all instances of `destroyIndex` to `close` and make the declaring interfaces extend `AutoCloseable`

Authors:
  - Lorenzo Dematté (https://github.com/ldematte)
  - MithunR (https://github.com/mythrocks)

Approvers:
  - MithunR (https://github.com/mythrocks)

URL: #1252

Author: ldematte

java/benchmarks/src/main/java/com/nvidia/cuvs/CagraIndexBenchmarks.java

@@ -121,20 +121,20 @@ public void testIndexingAndSerializeToFile() throws Throwable {
                 .build();
 
             // Create the index with the dataset
-            CagraIndex index = CagraIndex.newBuilder(resources)
+            try (CagraIndex index = CagraIndex.newBuilder(resources)
                 .withDataset(arrayDataset)
                 .withIndexParams(indexParams)
-                .build();
+                .build()) {
 
-            // Saving the index on to the disk.
-            var indexFilePath = Path.of(UUID.randomUUID() + ".cag");
-            try (var outputStream = Files.newOutputStream(indexFilePath)) {
+              // Saving the index on to the disk.
+              var indexFilePath = Path.of(UUID.randomUUID() + ".cag");
+              try (var outputStream = Files.newOutputStream(indexFilePath)) {
                 index.serialize(outputStream);
-            }
+              }
 
-            // Cleanup
-            Files.deleteIfExists(indexFilePath);
-            index.destroyIndex();
+              // Cleanup
+              Files.deleteIfExists(indexFilePath);
+            }
         }
     }
 

java/cuvs-java/src/main/java/com/nvidia/cuvs/BruteForceIndex.java

@@ -28,13 +28,14 @@
  *
  * @since 25.02
  */
-public interface BruteForceIndex {
+public interface BruteForceIndex extends AutoCloseable {
 
   /**
    * Invokes the native destroy_brute_force_index function to de-allocate
    * BRUTEFORCE index
    */
-  void destroyIndex() throws Throwable;
+  @Override
+  void close() throws Exception;
 
   /**
    * Invokes the native search_brute_force_index via the Panama API for searching

java/cuvs-java/src/main/java/com/nvidia/cuvs/CagraIndex.java

@@ -33,12 +33,13 @@
  *
  * @since 25.02
  */
-public interface CagraIndex {
+public interface CagraIndex extends AutoCloseable {
 
   /**
    * Invokes the native destroy_cagra_index to de-allocate the CAGRA index
    */
-  void destroyIndex() throws Throwable;
+  @Override
+  void close() throws Exception;
 
   /**
    * Invokes the native search_cagra_index via the Panama API for searching a

java/cuvs-java/src/main/java/com/nvidia/cuvs/HnswIndex.java

@@ -25,12 +25,13 @@
  *
  * @since 25.02
  */
-public interface HnswIndex {
+public interface HnswIndex extends AutoCloseable {
 
   /**
    * Invokes the native destroy_hnsw_index to de-allocate the HNSW index
    */
-  void destroyIndex() throws Throwable;
+  @Override
+  void close() throws Exception;
 
   /**
    * Invokes the native search_hnsw_index via the Panama API for searching a HNSW

java/cuvs-java/src/main/java/com/nvidia/cuvs/TieredIndex.java

@@ -23,15 +23,16 @@
  * {@link TieredIndex} encapsulates a Tiered index, along with methods to
  * interact with it.
  */
-public interface TieredIndex {
+public interface TieredIndex extends AutoCloseable {
 
   /**
    * Destroys the underlying native TieredIndex object and releases associated
    * resources.
    *
-   * @throws Throwable if an error occurs during index destruction
+   * @throws Exception if an error occurs during index destruction
    */
-  void destroyIndex() throws Throwable;
+  @Override
+  void close() throws Exception;
 
   /**
    * Searches the index with the specified query and search parameters.

java/cuvs-java/src/main/java22/com/nvidia/cuvs/internal/BruteForceIndexImpl.java

@@ -113,7 +113,7 @@ private void checkNotDestroyed() {
    * BRUTEFORCE index
    */
   @Override
-  public void destroyIndex() {
+  public void close() {
     checkNotDestroyed();
     try {
       int returnValue = cuvsBruteForceIndexDestroy(bruteForceIndexReference.indexPtr);

java/cuvs-java/src/main/java22/com/nvidia/cuvs/internal/CagraIndexImpl.java

@@ -158,7 +158,7 @@ private void checkNotDestroyed() {
    * Invokes the native destroy_cagra_index to de-allocate the CAGRA index
    */
   @Override
-  public void destroyIndex() throws Throwable {
+  public void close() {
     checkNotDestroyed();
     try {
       int returnValue = cuvsCagraIndexDestroy(cagraIndexReference.getMemorySegment());

java/cuvs-java/src/main/java22/com/nvidia/cuvs/internal/HnswIndexImpl.java

@@ -74,7 +74,7 @@ private HnswIndexImpl(
    * Invokes the native destroy_hnsw_index to de-allocate the HNSW index
    */
   @Override
-  public void destroyIndex() {
+  public void close() {
     int returnValue = cuvsHnswIndexDestroy(hnswIndexReference.getMemorySegment());
     checkCuVSError(returnValue, "cuvsHnswIndexDestroy");
   }

java/cuvs-java/src/main/java22/com/nvidia/cuvs/internal/TieredIndexImpl.java

@@ -94,7 +94,7 @@ private void checkNotDestroyed() {
    * Invokes the native destroy_tiered_index to de-allocate the Tiered index
    */
   @Override
-  public void destroyIndex() {
+  public void close() {
     checkNotDestroyed();
     try {
       int returnValue = cuvsTieredIndexDestroy(tieredIndexReference.getMemorySegment());

java/cuvs-java/src/test/java/com/nvidia/cuvs/BruteForceAndSearchIT.java

@@ -57,37 +57,34 @@ private static void indexAndQueryOnce(
         new BruteForceIndexParams.Builder().withNumWriterThreads(32).build();
 
     // Create the index with the dataset
-    BruteForceIndex index =
+    try (BruteForceIndex index =
         BruteForceIndex.newBuilder(resources)
             .withDataset(dataset)
             .withIndexParams(indexParams)
-            .build();
+            .build()) {
 
-    // Saving the index on to the disk.
-    String indexFileName = UUID.randomUUID() + ".bf";
-    try (var outputStream = new FileOutputStream(indexFileName)) {
-      index.serialize(outputStream);
-    }
-
-    // Loading a BRUTEFORCE index from disk.
-    Path indexFile = Path.of(indexFileName);
-    try (var inputStream = Files.newInputStream(indexFile)) {
-      BruteForceIndex loadedIndex = BruteForceIndex.newBuilder(resources).from(inputStream).build();
+      // Saving the index on to the disk.
+      String indexFileName = UUID.randomUUID() + ".bf";
+      try (var outputStream = new FileOutputStream(indexFileName)) {
+        index.serialize(outputStream);
+      }
 
-      // search the loaded index
-      SearchResults results = loadedIndex.search(cuvsQuery);
-      checkResults(expectedResults, results.getResults());
+      // Loading a BRUTEFORCE index from disk.
+      Path indexFile = Path.of(indexFileName);
+      try (var inputStream = Files.newInputStream(indexFile);
+          BruteForceIndex loadedIndex =
+              BruteForceIndex.newBuilder(resources).from(inputStream).build()) {
 
-      // search the first index
-      results = index.search(cuvsQuery);
-      checkResults(expectedResults, results.getResults());
+        // search the loaded index
+        SearchResults results = loadedIndex.search(cuvsQuery);
+        checkResults(expectedResults, results.getResults());
 
-      // Cleanup
-      index.destroyIndex();
-      loadedIndex.destroyIndex();
+        // search the first index
+        results = index.search(cuvsQuery);
+        checkResults(expectedResults, results.getResults());
+      }
+      Files.deleteIfExists(indexFile);
     }
-
-    Files.deleteIfExists(indexFile);
   }
 
   /**