Merge pull request #683 from apache/Cleanup_phase1

Cleanup phase 1

Author: leerho

src/main/java/org/apache/datasketches/common/Family.java

@@ -177,7 +177,7 @@ public enum Family {
       lookupFamName.put(f.getFamilyName().toUpperCase(Locale.US), f);
     }
     if (ByteOrder.nativeOrder() != ByteOrder.LITTLE_ENDIAN) {
-      throw new BigEndianNativeOrderNotSupportedException();
+      throw new SketchesNotSupportedException("Machine Native Endianness must be LITTLE_ENDIAN.");
     }
   }
 

src/main/java/org/apache/datasketches/common/MemorySegmentRequest.java

@@ -50,12 +50,16 @@ default MemorySegment request(final MemorySegment prevSeg, final long newByteSiz
    * It is up to the user to override this as appropriate.
    * @param prevSeg the previous MemorySegment to be closed.
    */
-  default void requestClose(final MemorySegment prevSeg) { }
+  default void requestClose(final MemorySegment prevSeg) {
+    //Because the default request goes on the heap, this default is a no-op
+  }
 
   /**
    * This class implements the defaults
    */
-  public static class Default implements MemorySegmentRequest { }
+  public static class Default implements MemorySegmentRequest {
+    //A convenience class that creates the target for the static member DEFAULT.
+  }
 
   /**
    * Create Default as static member.

…ianNativeOrderNotSupportedException.java …ommon/SketchesNotSupportedException.javasrc/main/java/org/apache/datasketches/common/BigEndianNativeOrderNotSupportedException.java renamed to src/main/java/org/apache/datasketches/common/SketchesNotSupportedException.java src/main/java/org/apache/datasketches/common/BigEndianNativeOrderNotSupportedException.java renamed to src/main/java/org/apache/datasketches/common/SketchesNotSupportedException.java

@@ -20,16 +20,28 @@
 package org.apache.datasketches.common;
 
 /**
- * The DataSketches Library is not supported on Big Endian machines.
+ * This operation or mode is not supported.
+ *
+ * @author Lee Rhodes
  */
-public class BigEndianNativeOrderNotSupportedException extends SketchesException {
+public class SketchesNotSupportedException extends SketchesException {
   private static final long serialVersionUID = 1L;
+  private static final String baseStr = "This operation or mode is not supported: ";
+
+  //other constructors to be added as needed.
 
   /**
-   * Constructs a new runtime exception with the message:
-   * "The DataSketches Library is not supported on Big Endian machines."
+   * Constructs a new runtime exception with the specified detail message. The cause is not
+   * initialized, and may subsequently be initialized by a call to
+   * Throwable.initCause(java.lang.Throwable).
+   *
+   * @param message the detail message which is appended to the base message:<br>
+   * "This operation or mode is not supported: ".
+   *
+   * <p>The detail message is saved for later retrieval by the Throwable.getMessage() method.</p>
    */
-  public BigEndianNativeOrderNotSupportedException() {
-    super("The DataSketches Library is not supported on Big Endian machines.");
+  public SketchesNotSupportedException(final String message) {
+    super(baseStr + message);
   }
+
 }

src/main/java/org/apache/datasketches/common/Util.java

@@ -41,7 +41,7 @@ public final class Util {
 
   static {
     if (ByteOrder.nativeOrder() != ByteOrder.LITTLE_ENDIAN) {
-      throw new BigEndianNativeOrderNotSupportedException();
+      throw new SketchesNotSupportedException("Machine Native Endianness must be LITTLE_ENDIAN.");
     }
   }
 

src/main/java/org/apache/datasketches/hll/AbstractCoupons.java

@@ -112,13 +112,13 @@ boolean isRebuildCurMinNumKxQFlag() {
   }
 
   @Override
-  void putEmptyFlag(final boolean empty) {} //no-op for coupons
+  void putEmptyFlag(final boolean empty) { /*no-op for coupons */ }
 
   @Override
-  void putOutOfOrder(final boolean outOfOrder) {} //no-op for coupons
+  void putOutOfOrder(final boolean outOfOrder) { /*no-op for coupons */ }
 
   @Override
-  void putRebuildCurMinNumKxQFlag(final boolean rebuild) {} //no-op for coupons
+  void putRebuildCurMinNumKxQFlag(final boolean rebuild) { /*no-op for coupons */ }
 
   @Override
   byte[] toCompactByteArray() {

src/main/java/org/apache/datasketches/hll/DirectCouponHashSet.java

@@ -55,9 +55,8 @@ final class DirectCouponHashSet extends DirectCouponList {
   }
 
   //Constructs this sketch with read-only data, may be compact.
-  DirectCouponHashSet(final int lgConfigK, final TgtHllType tgtHllType, final MemorySegment seg,
-      final boolean readOnly) {
-    super(lgConfigK, tgtHllType, CurMode.SET, seg, true);
+  DirectCouponHashSet(final int lgConfigK, final TgtHllType tgtHllType, final MemorySegment seg, final boolean readOnly) {
+    super(lgConfigK, tgtHllType, CurMode.SET, seg, readOnly);
     assert seg.get(JAVA_BYTE, LG_K_BYTE) > 7;
   }
 

src/main/java/org/apache/datasketches/hll/DirectCouponList.java

@@ -82,7 +82,7 @@ private static int checkSegCompactFlag(final MemorySegment wseg, final int lgCon
       final boolean readOnly) {
     super(lgConfigK, tgtHllType, curMode);
     wseg = null;
-    this.seg = seg;
+    this.seg = readOnly ? seg.asReadOnly() : seg;
     compact = extractCompactFlag(seg);
   }
 

src/main/java/org/apache/datasketches/hll/DirectHll4Array.java

@@ -53,7 +53,7 @@ final class DirectHll4Array extends DirectHllArray {
 
   //Called by HllSketch.wrap(MemorySegment)
   DirectHll4Array(final int lgConfigK, final MemorySegment seg, final boolean readOnly) {
-    super(lgConfigK, TgtHllType.HLL_4, seg, true);
+    super(lgConfigK, TgtHllType.HLL_4, seg, readOnly);
     final int auxCount = extractAuxCount(seg);
     if (auxCount > 0) {
       final boolean compact = extractCompactFlag(seg);

src/main/java/org/apache/datasketches/hll/DirectHll6Array.java

@@ -40,7 +40,7 @@ final class DirectHll6Array extends DirectHllArray {
 
   //Called by HllSketch.wrap(MemorySegment)
   DirectHll6Array(final int lgConfigK, final MemorySegment seg, final boolean readOnly) {
-    super(lgConfigK, TgtHllType.HLL_6, seg, true);
+    super(lgConfigK, TgtHllType.HLL_6, seg, readOnly);
   }
 
   @Override

src/main/java/org/apache/datasketches/hll/DirectHll8Array.java

@@ -42,7 +42,7 @@ final class DirectHll8Array extends DirectHllArray {
 
   //Called by HllSketch.wrap(MemorySegment)
   DirectHll8Array(final int lgConfigK, final MemorySegment seg, final boolean readOnly) {
-    super(lgConfigK, TgtHllType.HLL_8, seg, true);
+    super(lgConfigK, TgtHllType.HLL_8, seg, readOnly);
   }
 
   @Override