You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datasketches.apache.org by le...@apache.org on 2022/12/17 00:02:48 UTC

[datasketches-memory] branch IntegrateJava17_v2 updated: Completed rename of "isValid()" to "isAlive()" -- consistent with Java 17 Panama.

This is an automated email from the ASF dual-hosted git repository.

leerho pushed a commit to branch IntegrateJava17_v2
in repository https://gitbox.apache.org/repos/asf/datasketches-memory.git


The following commit(s) were added to refs/heads/IntegrateJava17_v2 by this push:
     new b189436  Completed rename of "isValid()" to "isAlive()" -- consistent with Java 17 Panama.
b189436 is described below

commit b1894367f4602e96c6daf7955cafd3af32e41ff9
Author: Lee Rhodes <le...@users.noreply.github.com>
AuthorDate: Fri Dec 16 16:02:36 2022 -0800

    Completed rename of "isValid()" to "isAlive()" -- consistent with Java
    17 Panama.
---
 .../org/apache/datasketches/memory/BaseState.java   | 21 +++++++++++----------
 .../datasketches/memory/internal/BaseStateImpl.java | 16 ++++++++--------
 .../internal/DirectNonNativeWritableBufferImpl.java |  2 +-
 .../internal/DirectNonNativeWritableMemoryImpl.java |  2 +-
 .../memory/internal/DirectWritableBufferImpl.java   |  2 +-
 .../memory/internal/DirectWritableMemoryImpl.java   |  2 +-
 .../internal/MapNonNativeWritableBufferImpl.java    |  2 +-
 .../internal/MapNonNativeWritableMemoryImpl.java    |  2 +-
 .../memory/internal/MapWritableBufferImpl.java      |  2 +-
 .../memory/internal/MapWritableMemoryImpl.java      |  2 +-
 .../internal/AllocateDirectMapMemoryTest.java       |  7 +++----
 .../memory/internal/DruidIssue11544Test.java        |  9 ++++-----
 .../internal/ExampleMemoryRequestServerTest.java    |  3 +--
 .../datasketches/memory/internal/LeafImplTest.java  |  9 ++++-----
 .../internal/NativeWritableBufferImplTest.java      |  2 +-
 .../internal/NativeWritableMemoryImplTest.java      |  2 +-
 16 files changed, 41 insertions(+), 44 deletions(-)

diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/BaseState.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/BaseState.java
index c17f14c..1ed7378 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/BaseState.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/BaseState.java
@@ -76,12 +76,12 @@ public interface BaseState {
    */
   boolean hasByteBuffer();
 
-//  /**
-//   * Is this resource alive?
-//   * @return true, if this resource is alive. That is, it has not been closed.
-//   * @see close()
-//   */
-//  boolean isAlive();
+  /**
+   * Is this resource alive?
+   * @return true, if this resource is alive. That is, it has not been closed.
+   * @see close()
+   */
+  boolean isAlive();
 
   /**
    * Returns true if the Native ByteOrder is the same as the ByteOrder of the
@@ -138,7 +138,7 @@ public interface BaseState {
    */
   long xxHash64(long offsetBytes, long lengthBytes, long seed);
 
-  //DEPRECATED. DOES NOT EXIST FOR JAVA 17+ VERSIONS
+  //DEPRECATED. NOT SUPPORTED AS OF JAVA 17+ VERSIONS
 
   /**
    * Returns true if the backing resource of <i>this</i> is identical with the backing resource
@@ -147,7 +147,7 @@ public interface BaseState {
    * @param that A different non-null object
    * @return true if the backing resource of <i>this</i> is the same as the backing resource
    * of <i>that</i>.
-   * @deprecated no longer required or supported for Java 17 versions. Use nativeOverlap(BaseState) instead.
+   * @deprecated no longer supported as of Java 17 versions. Use nativeOverlap(BaseState) instead.
    */
   @Deprecated
   boolean isSameResource(Object that);
@@ -156,9 +156,10 @@ public interface BaseState {
    * Returns true if this object is valid and has not been closed.
    * This is relevant only for direct (off-heap) memory and Mapped Files.
    * @return true if this object is valid and has not been closed.
-   * deprecated no longer supported for Java 17 versions. Use <i>isAlive()</i> instead
+   * @deprecated no longer supported as of Java 17 versions. Use <i>isAlive()</i> instead.
    */
   //@Deprecated
-  boolean isValid();
+  @Deprecated
+  default boolean isValid() { return isAlive(); }
 
 }
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
index 9c2bb0e..e21cea2 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/BaseStateImpl.java
@@ -217,7 +217,7 @@ public abstract class BaseStateImpl implements BaseState {
     sb.append("Capacity            : ").append(capacity).append(LS);
     sb.append("CumBaseOffset       : ").append(cumBaseOffset).append(LS);
     sb.append("MemReqSvr, hashCode : ").append(memReqStr).append(LS);
-    sb.append("Valid               : ").append(state.isValid()).append(LS);
+    sb.append("Valid               : ").append(state.isAlive()).append(LS);
     sb.append("Read Only           : ").append(state.isReadOnly()).append(LS);
     sb.append("Type Byte Order     : ").append(state.getByteOrder().toString()).append(LS);
     sb.append("Native Byte Order   : ").append(NATIVE_BYTE_ORDER.toString()).append(LS);
@@ -288,7 +288,7 @@ public abstract class BaseStateImpl implements BaseState {
   //**NON STATIC METHODS*****************************************
 
   void checkValid() { //Java 8 & 11 only
-    if (!isValid()) {
+    if (!isAlive()) {
       throw new IllegalStateException("Memory not valid.");
     }
   }
@@ -364,6 +364,12 @@ public abstract class BaseStateImpl implements BaseState {
     return (int) xxHash64(0, capacityBytes_, 0); //xxHash64() calls checkValid()
   }
 
+  //Overridden by Direct and Map leafs
+  @Override
+  public boolean isAlive() {
+    return true;
+  }
+
   final boolean isByteBufferType() {
     return (getTypeId() & BYTEBUF) > 0;
   }
@@ -435,12 +441,6 @@ public abstract class BaseStateImpl implements BaseState {
             && getByteBuffer() == that1.getByteBuffer();
   }
 
-  //Overridden by Direct and Map leafs
-  @Override
-  public boolean isValid() { //Java 8 & 11 only
-    return true;
-  }
-
   @Override
   public final String toHexString(final String header, final long offsetBytes,
       final int lengthBytes) {
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableBufferImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableBufferImpl.java
index bae8609..1ea130d 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableBufferImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableBufferImpl.java
@@ -99,7 +99,7 @@ final class DirectNonNativeWritableBufferImpl extends NonNativeWritableBufferImp
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableMemoryImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableMemoryImpl.java
index 6a5cc24..484a193 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableMemoryImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectNonNativeWritableMemoryImpl.java
@@ -89,7 +89,7 @@ final class DirectNonNativeWritableMemoryImpl extends NonNativeWritableMemoryImp
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableBufferImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableBufferImpl.java
index e8fbf71..921480f 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableBufferImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableBufferImpl.java
@@ -99,7 +99,7 @@ final class DirectWritableBufferImpl extends NativeWritableBufferImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableMemoryImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableMemoryImpl.java
index fde58fe..0f30939 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableMemoryImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/DirectWritableMemoryImpl.java
@@ -89,7 +89,7 @@ final class DirectWritableMemoryImpl extends NativeWritableMemoryImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableBufferImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableBufferImpl.java
index a0380a0..2008d65 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableBufferImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableBufferImpl.java
@@ -95,7 +95,7 @@ final class MapNonNativeWritableBufferImpl extends NonNativeWritableBufferImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableMemoryImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableMemoryImpl.java
index 00f9253..6a6faaf 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableMemoryImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapNonNativeWritableMemoryImpl.java
@@ -85,7 +85,7 @@ final class MapNonNativeWritableMemoryImpl extends NonNativeWritableMemoryImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableBufferImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableBufferImpl.java
index ecccfc9..f87ab5c 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableBufferImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableBufferImpl.java
@@ -95,7 +95,7 @@ final class MapWritableBufferImpl extends NativeWritableBufferImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableMemoryImpl.java b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableMemoryImpl.java
index 6cfe5c0..2b8501d 100644
--- a/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableMemoryImpl.java
+++ b/datasketches-memory-java8/src/main/java/org/apache/datasketches/memory/internal/MapWritableMemoryImpl.java
@@ -85,7 +85,7 @@ final class MapWritableMemoryImpl extends NativeWritableMemoryImpl {
   }
 
   @Override
-  public boolean isValid() {
+  public boolean isAlive() {
     return valid.get();
   }
 
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/AllocateDirectMapMemoryTest.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/AllocateDirectMapMemoryTest.java
index ea47eae..2e09576 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/AllocateDirectMapMemoryTest.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/AllocateDirectMapMemoryTest.java
@@ -39,7 +39,6 @@ import org.testng.annotations.AfterClass;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
 
-@SuppressWarnings("deprecation")
 public class AllocateDirectMapMemoryTest {
   MapHandle hand = null;
 
@@ -123,7 +122,7 @@ public class AllocateDirectMapMemoryTest {
       hand = rh;
       mem = rh.get();
     } //TWR closes
-    assertFalse(mem.isValid());
+    assertFalse(mem.isAlive());
     //println(""+mem.isValid());
   }
 
@@ -142,9 +141,9 @@ public class AllocateDirectMapMemoryTest {
   public void afterAllTests() throws Exception {
       if (hand != null) {
       Memory mem = hand.get();
-      if ((mem != null) && mem.isValid()) {
+      if ((mem != null) && mem.isAlive()) {
         hand.close();
-        assertFalse(mem.isValid());
+        assertFalse(mem.isAlive());
       }
     }
   }
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/DruidIssue11544Test.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/DruidIssue11544Test.java
index 4db938f..b48b8ca 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/DruidIssue11544Test.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/DruidIssue11544Test.java
@@ -48,7 +48,6 @@ import org.testng.annotations.Test;
  * @author Lee Rhodes
  *
  */
-@SuppressWarnings("deprecation")
 public class DruidIssue11544Test {
 
   @Test
@@ -87,8 +86,8 @@ public class DruidIssue11544Test {
     //Prepare to request deallocation
     //In the DefaultMemoryRequestServer, this is a no-op, so nothing is actually deallocated.
     svr.requestClose(mem1, mem2);
-    assertTrue(mem1.isValid());
-    assertTrue(mem2.isValid());
+    assertTrue(mem1.isAlive());
+    assertTrue(mem2.isAlive());
 
     //Now we are on the heap and need to grow again:
     int size3 = size2 * 2;
@@ -104,8 +103,8 @@ public class DruidIssue11544Test {
     //Prepare to request deallocation
 
     svr.requestClose(mem2, mem3); //No-op
-    assertTrue(mem2.isValid());
-    assertTrue(mem3.isValid());
+    assertTrue(mem2.isAlive());
+    assertTrue(mem3.isAlive());
   }
 
 }
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/ExampleMemoryRequestServerTest.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/ExampleMemoryRequestServerTest.java
index c75553d..528bde9 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/ExampleMemoryRequestServerTest.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/ExampleMemoryRequestServerTest.java
@@ -34,7 +34,6 @@ import org.testng.annotations.Test;
  * Examples of how to use the MemoryRequestServer with a memory hungry client.
  * @author Lee Rhodes
  */
-@SuppressWarnings("deprecation")
 public class ExampleMemoryRequestServerTest {
 
   /**
@@ -155,7 +154,7 @@ public class ExampleMemoryRequestServerTest {
 
     public void cleanup() {
       map.forEach((k,v) -> {
-        assertFalse(k.isValid()); //all entries in the map should be invalid
+        assertFalse(k.isAlive()); //all entries in the map should be invalid
         try {
           v.close();
         } catch (Exception e) {
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/LeafImplTest.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/LeafImplTest.java
index 51bfb5a..0defa50 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/LeafImplTest.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/LeafImplTest.java
@@ -42,7 +42,6 @@ import org.testng.annotations.Test;
 /**
  * @author Lee Rhodes
  */
-@SuppressWarnings("deprecation")
 public class LeafImplTest {
   private static final MemoryRequestServer dummyMemReqSvr = new DummyMemoryRequestServer();
 
@@ -198,7 +197,7 @@ public class LeafImplTest {
       assertNotNull(obj);
     }
 
-    assertTrue(mem.isValid() == true);
+    assertTrue(mem.isAlive() == true);
 
     WritableBuffer buf = mem.asWritableBuffer();
 
@@ -223,7 +222,7 @@ public class LeafImplTest {
       assertNotNull(obj);
     }
 
-    assertTrue(buf.isValid() == true);
+    assertTrue(buf.isAlive() == true);
 
     WritableMemory nnMem = mem.writableRegion(off, cap, oo);
 
@@ -248,7 +247,7 @@ public class LeafImplTest {
       assertNotNull(obj);
     }
 
-    assertTrue(nnMem.isValid() == true);
+    assertTrue(nnMem.isAlive() == true);
 
     WritableBuffer nnBuf = mem.asWritableBuffer(oo);
 
@@ -273,7 +272,7 @@ public class LeafImplTest {
       assertNotNull(obj);
     }
 
-    assertTrue(nnBuf.isValid() == true);
+    assertTrue(nnBuf.isAlive() == true);
   }
 
 }
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableBufferImplTest.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableBufferImplTest.java
index 75cac3b..7f5572f 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableBufferImplTest.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableBufferImplTest.java
@@ -53,7 +53,7 @@ public class NativeWritableBufferImplTest {
     assertEquals(wbuf.getCapacity(), memCapacity);
 
     wmh.close(); //intentional
-    assertFalse(wbuf.isValid());
+    assertFalse(wbuf.isAlive());
 
     wmh.close(); //intentional, nothing to free
   }
diff --git a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableMemoryImplTest.java b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableMemoryImplTest.java
index df67ef8..1ea90f6 100644
--- a/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableMemoryImplTest.java
+++ b/datasketches-memory-java8/src/test/java/org/apache/datasketches/memory/internal/NativeWritableMemoryImplTest.java
@@ -51,7 +51,7 @@ public class NativeWritableMemoryImplTest {
     assertEquals(memCapacity, mem.getCapacity());
 
     wmh.close(); //intentional
-    assertFalse(mem.isValid());
+    assertFalse(mem.isAlive());
 
     wmh.close(); //intentional, nothing to free
   }


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datasketches.apache.org
For additional commands, e-mail: commits-help@datasketches.apache.org