Deprecate classes where functionality is already provided

Author: aherbert

gdsc-core/src/main/java/uk/ac/sussex/gdsc/core/utils/OpenHashMaps.java

@@ -42,11 +42,17 @@
  * href="https://github.com/vigna/fastutil">fastutil collections library</a>.
  *
  * <p>The extensions provide zero-allocation forEach iteration of the entries in the map.
+ *
+ * @deprecated Functionality is now available in the fastutil OpenHashMap implementations.
  */
+@Deprecated
 public final class OpenHashMaps {
   /**
    * Customisation of Long2IntOpenHashMap.
+   * 
+   * @deprecated Functionality is now available in the fastutil OpenHashMap implementations.
    */
+  @Deprecated
   public static class CustomLong2IntOpenHashMap extends Long2IntOpenHashMap {
     private static final long serialVersionUID = 1L;
 
@@ -72,20 +78,17 @@ public CustomLong2IntOpenHashMap(int expected) {
      * @param action the action
      */
     public void forEach(LongIntConsumer action) {
-      if (containsNullKey) {
-        action.accept(key[n], value[n]);
-      }
-      for (int pos = n; pos-- != 0;) {
-        if (key[pos] != 0) {
-          action.accept(key[pos], value[pos]);
-        }
-      }
+      // Delegate
+      super.forEach(action::accept);
     }
   }
 
   /**
    * Customisation of Int2IntOpenHashMap.
+   * 
+   * @deprecated Functionality is now available in the fastutil OpenHashMap implementations.
    */
+  @Deprecated
   public static class CustomInt2IntOpenHashMap extends Int2IntOpenHashMap {
     private static final long serialVersionUID = 1L;
 
@@ -111,22 +114,18 @@ public CustomInt2IntOpenHashMap(int expected) {
      * @param action the action
      */
     public void forEach(IntIntConsumer action) {
-      if (containsNullKey) {
-        action.accept(key[n], value[n]);
-      }
-      for (int pos = n; pos-- != 0;) {
-        if (key[pos] != 0) {
-          action.accept(key[pos], value[pos]);
-        }
-      }
+      // Delegate
+      super.forEach(action::accept);
     }
   }
 
   /**
    * Customisation of Int2ObjectOpenHashMap.
    *
    * @param <T> the element type
+   * @deprecated Functionality is now available in the fastutil OpenHashMap implementations.
    */
+  @Deprecated
   public static class CustomInt2ObjectOpenHashMap<T> extends Int2ObjectOpenHashMap<T> {
     private static final long serialVersionUID = 1L;
 
@@ -152,22 +151,18 @@ public CustomInt2ObjectOpenHashMap(int expected) {
      * @param action the action
      */
     public void forEach(IntObjConsumer<T> action) {
-      if (containsNullKey) {
-        action.accept(key[n], value[n]);
-      }
-      for (int pos = n; pos-- != 0;) {
-        if (key[pos] != 0) {
-          action.accept(key[pos], value[pos]);
-        }
-      }
+      // Delegate
+      super.forEach(action::accept);
     }
   }
 
   /**
    * Customisation of Object2IntOpenHashMap.
    *
    * @param <T> the element type
+   * @deprecated Functionality is now available in the fastutil OpenHashMap implementations.
    */
+  @Deprecated
   public static class CustomObject2IntOpenHashMap<T> extends Object2IntOpenHashMap<T> {
     private static final long serialVersionUID = 1L;
 
@@ -193,14 +188,8 @@ public CustomObject2IntOpenHashMap(int expected) {
      * @param action the action
      */
     public void forEach(ObjIntConsumer<T> action) {
-      if (containsNullKey) {
-        action.accept(key[n], value[n]);
-      }
-      for (int pos = n; pos-- != 0;) {
-        if (key[pos] != null) {
-          action.accept(key[pos], value[pos]);
-        }
-      }
+      // Delegate
+      super.forEach(action::accept);
     }
   }
 

gdsc-core/src/test/java/uk/ac/sussex/gdsc/core/utils/OpenHashMapsTest.java

@@ -28,75 +28,79 @@
 
 package uk.ac.sussex.gdsc.core.utils;
 
+import java.util.function.ObjIntConsumer;
 import org.apache.commons.rng.UniformRandomProvider;
 import org.junit.jupiter.api.Assertions;
 import uk.ac.sussex.gdsc.core.utils.OpenHashMaps.CustomInt2IntOpenHashMap;
 import uk.ac.sussex.gdsc.core.utils.OpenHashMaps.CustomInt2ObjectOpenHashMap;
 import uk.ac.sussex.gdsc.core.utils.OpenHashMaps.CustomLong2IntOpenHashMap;
 import uk.ac.sussex.gdsc.core.utils.OpenHashMaps.CustomObject2IntOpenHashMap;
+import uk.ac.sussex.gdsc.core.utils.function.IntIntConsumer;
+import uk.ac.sussex.gdsc.core.utils.function.IntObjConsumer;
+import uk.ac.sussex.gdsc.core.utils.function.LongIntConsumer;
 import uk.ac.sussex.gdsc.test.junit5.SeededTest;
 import uk.ac.sussex.gdsc.test.rng.RngFactory;
 import uk.ac.sussex.gdsc.test.utils.RandomSeed;
 
-@SuppressWarnings({"javadoc"})
+@SuppressWarnings({"javadoc", "deprecation"})
 class OpenHashMapsTest {
   @SeededTest
   void testLong2IntForEach(RandomSeed seed) {
     final UniformRandomProvider rng = RngFactory.create(seed.get());
     final CustomLong2IntOpenHashMap m = new CustomLong2IntOpenHashMap();
-    m.forEach((long k, int v) -> {
+    m.forEach((LongIntConsumer) (long k, int v) -> {
       Assertions.fail();
     });
     for (int i = 0; i < 5; i++) {
       m.put(rng.nextLong(), rng.nextInt());
     }
     final CustomLong2IntOpenHashMap m2 = new CustomLong2IntOpenHashMap(16);
-    m.forEach((long k, int v) -> m2.put(k, v));
+    m.forEach((LongIntConsumer) (long k, int v) -> m2.put(k, v));
     Assertions.assertEquals(m2, m);
   }
 
   @SeededTest
   void testInt2IntForEach(RandomSeed seed) {
     final UniformRandomProvider rng = RngFactory.create(seed.get());
     final CustomInt2IntOpenHashMap m = new CustomInt2IntOpenHashMap();
-    m.forEach((int k, int v) -> {
+    m.forEach((IntIntConsumer) (int k, int v) -> {
       Assertions.fail();
     });
     for (int i = 0; i < 5; i++) {
       m.put(rng.nextInt(), rng.nextInt());
     }
     final CustomInt2IntOpenHashMap m2 = new CustomInt2IntOpenHashMap(16);
-    m.forEach((int k, int v) -> m2.put(k, v));
+    m.forEach((IntIntConsumer) (int k, int v) -> m2.put(k, v));
     Assertions.assertEquals(m2, m);
   }
 
   @SeededTest
   void testObject2IntForEach(RandomSeed seed) {
     final UniformRandomProvider rng = RngFactory.create(seed.get());
     final CustomObject2IntOpenHashMap<Double> m = new CustomObject2IntOpenHashMap<>();
-    m.forEach((Double k, int v) -> {
+    m.forEach((ObjIntConsumer<Double>) (Double k, int v) -> {
       Assertions.fail();
     });
     for (int i = 0; i < 5; i++) {
       m.put(Double.valueOf(rng.nextDouble()), rng.nextInt());
     }
     final CustomObject2IntOpenHashMap<Double> m2 = new CustomObject2IntOpenHashMap<>(16);
-    m.forEach((Double k, int v) -> m2.put(k, v));
+    m.forEach((ObjIntConsumer<Double>) (Double k, int v) -> m2.put(k, v));
     Assertions.assertEquals(m2, m);
   }
 
   @SeededTest
   void testInt2ObjectForEach(RandomSeed seed) {
     final UniformRandomProvider rng = RngFactory.create(seed.get());
     final CustomInt2ObjectOpenHashMap<Double> m = new CustomInt2ObjectOpenHashMap<>();
-    m.forEach((int k, Double v) -> {
+    m.forEach((IntObjConsumer<Double>) (int k, Double v) -> {
       Assertions.fail();
     });
     for (int i = 0; i < 5; i++) {
       m.put(rng.nextInt(), Double.valueOf(rng.nextDouble()));
     }
     final CustomInt2ObjectOpenHashMap<Double> m2 = new CustomInt2ObjectOpenHashMap<>(16);
-    m.forEach((int k, Double v) -> m2.put(k, v));
+    m.forEach((IntObjConsumer<Double>) (int k, Double v) -> m2.put(k, v));
     Assertions.assertEquals(m2, m);
   }
 }