This huge update does not impact any code. It is mostly Javadoc updates.

There are also a few pom updates and some updates to the GH Action
workflows.

Author: leerho

.github/workflows/auto-jdk-matrix.yml

@@ -3,7 +3,7 @@ name: DataSketches-Java Auto JDK Matrix Test & Install
 on:
     pull_request:
     push:
-        branches: [ master ]
+        branches: [ master, main ]
     workflow_dispatch:
 
 env:

.github/workflows/auto-os-matrix.yml

@@ -3,7 +3,7 @@ name: DataSketches-Java Auto OS Matrix Test & Install
 on:
     pull_request:
     push:
-        branches: [ master ]
+        branches: [ master, main ]
     workflow_dispatch:
 
 env:
@@ -55,8 +55,6 @@ jobs:
               distribution: 'temurin'
               java-package: jdk
               architecture: x64 
-# Architecture options: x86, x64, armv7, aarch64, ppc64le
-# setup-java@v4 has a "with cache" option
 
         - name: Echo Java Version
           run: >
@@ -75,6 +73,8 @@ jobs:
               -D skipTests=true
               ${{matrix.os.skip_gpg}}
 
+# Architecture options: x86, x64, armv7, aarch64, ppc64le
+# setup-java@v4 has a "with cache" option
 # Lifecycle: validate, compile, test, package, verify, install, deploy
 # -B batch mode
 # -V show Version without stopping

.github/workflows/javadoc.yml

@@ -2,7 +2,7 @@ name: JavaDoc
 
 on:
   push:
-    branches: [7.0.X, master]
+    branches: [ master, main ]
   workflow_dispatch:
 
 jobs:
@@ -22,12 +22,15 @@ jobs:
       - name: Echo Java Version
         run:  java -version
 
+      - name: Print Current workflow
+        run: >
+         cat .github/workflows/javadoc.yml
+
       - name: Generate JavaDoc
         run: mvn javadoc:javadoc
 
       - name: Deploy JavaDoc
         uses: JamesIves/github-pages-deploy-action@v4.6.8
-        #uses: JamesIves/github-pages-deploy-action@881db5376404c5c8d621010bcbec0310b58d5e29 #alternate
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           folder: target/reports/apidocs

.github/workflows/manual-coverage.yml

@@ -95,40 +95,42 @@ under the License.
     <!-- System-wide properties -->
     <maven.version>3.6.3</maven.version>
     <java.version>17</java.version>
+    <add-modules>--add-modules=jdk.incubator.foreign</add-modules>
     <maven.compiler.source>${java.version}</maven.compiler.source>
     <maven.compiler.target>${java.version}</maven.compiler.target>
-    <argLine>-Xmx4g -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8 --add-modules=jdk.incubator.foreign</argLine>
+    <argLine>-Xmx4g -Duser.language=en -Duser.country=US -Dfile.encoding=UTF-8 ${add-modules}</argLine>
     <charset.encoding>UTF-8</charset.encoding>
     <project.build.sourceEncoding>${charset.encoding}</project.build.sourceEncoding>
     <project.build.resourceEncoding>${charset.encoding}</project.build.resourceEncoding>
     <project.reporting.outputEncoding>${charset.encoding}</project.reporting.outputEncoding>
     <maven.build.timestamp.format>yyyy-MM-dd'T'HH-mm-ss'Z'</maven.build.timestamp.format>
 
     <!--  org.apache.maven plugins -->
-     <maven-assembly-plugin.version>3.7.1</maven-assembly-plugin.version>
-     <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
-     <maven-deploy-plugin.version>3.1.3</maven-deploy-plugin.version>
-     <maven-enforcer-plugin.version>3.5.0</maven-enforcer-plugin.version>
-     <maven-gpg-plugin.version>3.2.5</maven-gpg-plugin.version>
-     <maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>
-     <maven-javadoc-plugin.version>3.8.0</maven-javadoc-plugin.version>
-     <maven-release-plugin.version>3.1.1</maven-release-plugin.version>
-     <maven-remote-resources-plugin.version>3.2.0</maven-remote-resources-plugin.version>
-     <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
-     <maven-surefire-failsafe-plugins.version>3.4.0</maven-surefire-failsafe-plugins.version> <!-- for surefire, failsafe and surefire-report-->
-     <!-- com.github plugins -->
-     <git-commit-id-plugin.version>4.9.10</git-commit-id-plugin.version>    
-     <!-- org.apache.creadur plugins -->
-     <apache-rat-plugin.version>0.16.1</apache-rat-plugin.version> 
-     <!-- org.eluder maven plugins -->
-     <coveralls-repo-token></coveralls-repo-token>
-     <coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
-     <!-- org.jacoco maven plugins -->
-     <jacoco-maven-plugin.version>0.8.12</jacoco-maven-plugin.version>
-     <!-- org.mojohaus plugins -->
-     <versions-maven-plugin.version>2.17.1</versions-maven-plugin.version>
-     <!-- other -->
-     <lifecycle-mapping.version>1.0.0</lifecycle-mapping.version>
+    <maven-assembly-plugin.version>3.7.1</maven-assembly-plugin.version>
+    <maven-compiler-plugin.version>3.13.0</maven-compiler-plugin.version>
+    <maven-deploy-plugin.version>3.1.3</maven-deploy-plugin.version>
+    <maven-enforcer-plugin.version>3.5.0</maven-enforcer-plugin.version>
+    <maven-gpg-plugin.version>3.2.7</maven-gpg-plugin.version>
+    <maven-jar-plugin.version>3.4.2</maven-jar-plugin.version>
+    <maven-javadoc-plugin.version>3.11.1</maven-javadoc-plugin.version>
+    <maven-release-plugin.version>3.1.1</maven-release-plugin.version>
+    <maven-remote-resources-plugin.version>3.2.0</maven-remote-resources-plugin.version>
+    <maven-source-plugin.version>3.3.1</maven-source-plugin.version>
+    <maven-surefire-failsafe-plugins.version>3.5.2</maven-surefire-failsafe-plugins.version> <!-- for surefire, failsafe and surefire-report -->
+    <maven-toolchains-plugin.version>3.2.0</maven-toolchains-plugin.version>
+    <!-- com.github plugins -->
+    <git-commit-id-plugin.version>4.9.10</git-commit-id-plugin.version>
+    <!-- org.apache.creadur plugins -->
+    <apache-rat-plugin.version>0.16.1</apache-rat-plugin.version>
+    <!-- org.eluder maven plugins -->
+    <coveralls-repo-token></coveralls-repo-token>
+    <coveralls-maven-plugin.version>4.3.0</coveralls-maven-plugin.version>
+    <!-- org.jacoco.maven plugins -->
+    <jacoco-maven-plugin.version>0.8.12</jacoco-maven-plugin.version>
+    <!-- org.mojohaus plugins -->
+    <versions-maven-plugin.version>2.17.1</versions-maven-plugin.version>
+    <!-- other -->
+    <lifecycle-mapping.version>1.0.0</lifecycle-mapping.version>
   </properties>
 
   <dependencies>
@@ -145,13 +147,6 @@ under the License.
       <version>${testng.version}</version>
       <scope>test</scope>
     </dependency>
-    <!--
-    <dependency>
-      <groupId>org.apache.datasketches</groupId>
-      <artifactId>datasketches-java-common</artifactId>
-      <version>1.0.0</version>
-    </dependency>
-    -->
   </dependencies>
 
   <build>
@@ -169,7 +164,7 @@ under the License.
           <version>${maven-compiler-plugin.version}</version>
           <configuration>
             <compilerArgs>
-              <arg>--add-modules=jdk.incubator.foreign</arg>
+              <arg>${add-modules}</arg>
             </compilerArgs>
           </configuration>
         </plugin>
@@ -195,10 +190,10 @@ under the License.
               <configuration>
                 <rules>
                   <requireJavaVersion>
-                    <version>[17,18)</version>
+                    <version>${java.version}</version>
                   </requireJavaVersion>
                   <requireMavenVersion>
-                    <version>[${maven.version},)</version>
+                    <version>[${maven.version},4.0.0)</version>
                   </requireMavenVersion>
                   <bannedDependencies>
                     <excludes>
@@ -243,7 +238,7 @@ under the License.
             <docfilessubdirs>true</docfilessubdirs>
             <show>public</show>
             <additionalOptions>
-              <additionalOption>--add-modules=jdk.incubator.foreign</additionalOption>
+              <additionalOption>${add-modules}</additionalOption>
             </additionalOptions>
           </configuration>
           <executions>
@@ -289,7 +284,7 @@ under the License.
           <artifactId>maven-surefire-plugin</artifactId>
           <version>${maven-surefire-failsafe-plugins.version}</version>
           <configuration>
-            <argLine>--add-modules=jdk.incubator.foreign</argLine>
+            <argLine>${add-modules}</argLine>
             <trimStackTrace>false</trimStackTrace>
             <useManifestOnlyJar>false</useManifestOnlyJar>
             <redirectTestOutputToFile>true</redirectTestOutputToFile>
@@ -298,6 +293,26 @@ under the License.
           </configuration>
         </plugin>
 
+        <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-toolchains-plugin</artifactId>
+          <version>${maven-toolchains-plugin.version}</version>
+          <executions>
+            <execution>
+              <goals>
+                <goal>toolchain</goal>
+              </goals>
+            </execution>
+          </executions>
+          <configuration>
+            <toolchains>
+              <jdk>
+                <version>${java.version}</version>
+              </jdk>
+            </toolchains>
+          </configuration>
+        </plugin>
+
         <plugin>
           <groupId>org.apache.rat</groupId>
           <artifactId>apache-rat-plugin</artifactId>
@@ -402,6 +417,10 @@ under the License.
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-surefire-plugin</artifactId>
       </plugin>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-toolchains-plugin</artifactId>
+      </plugin>
       <plugin>
         <groupId>org.apache.rat</groupId>
         <artifactId>apache-rat-plugin</artifactId>

pom.xml

@@ -33,8 +33,8 @@
 import org.apache.datasketches.memory.XxHash;
 
 /**
- * <p>A Bloom filter is a data structure that can be used for probabilistic
- * set membership.</p>
+ * A Bloom filter is a data structure that can be used for probabilistic
+ * set membership.
  *
  * <p>When querying a Bloom filter, there are no false positives. Specifically:
  * When querying an item that has already been inserted to the filter, the filter will

src/main/java/org/apache/datasketches/filters/bloomfilter/BloomFilter.java

@@ -25,8 +25,8 @@
 import org.apache.datasketches.memory.WritableMemory;
 
 /**
- * <p>This class provides methods to help estimate the correct parameters when
- * creating a Bloom filter, and methods to create the filter using those values.</p>
+ * This class provides methods to help estimate the correct parameters when
+ * creating a Bloom filter, and methods to create the filter using those values.
  *
  * <p>The underlying math is described in the
  * <a href='https://en.wikipedia.org/wiki/Bloom_filter#Optimal_number_of_hash_functions'>

src/main/java/org/apache/datasketches/filters/bloomfilter/BloomFilterBuilder.java

@@ -55,10 +55,10 @@
 import org.apache.datasketches.memory.WritableMemory;
 
 /**
- * <p>This sketch is useful for tracking approximate frequencies of items of type <i>&lt;T&gt;</i>
+ * This sketch is useful for tracking approximate frequencies of items of type <i>&lt;T&gt;</i>
  * with optional associated counts (<i>&lt;T&gt;</i> item, <i>long</i> count) that are members of a
  * multiset of such items. The true frequency of an item is defined to be the sum of associated
- * counts.</p>
+ * counts.
  *
  * <p>This implementation provides the following capabilities:</p>
  * <ul>

src/main/java/org/apache/datasketches/frequencies/ItemsSketch.java

@@ -54,9 +54,9 @@
 import org.apache.datasketches.memory.WritableMemory;
 
 /**
- * <p>This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional
+ * This sketch is useful for tracking approximate frequencies of <i>long</i> items with optional
  * associated counts (<i>long</i> item, <i>long</i> count) that are members of a multiset of
- * such items. The true frequency of an item is defined to be the sum of associated counts.</p>
+ * such items. The true frequency of an item is defined to be the sum of associated counts.
  *
  * <p>This implementation provides the following capabilities:</p>
  * <ul>

src/main/java/org/apache/datasketches/frequencies/LongsSketch.java

@@ -31,6 +31,7 @@
 /**
  * This class defines the preamble data structure and provides basic utilities for some of the key
  * fields.
+ *
  * <p>
  * The intent of the design of this class was to isolate the detailed knowledge of the bit and byte
  * layout of the serialized form of the sketches derived from the Sketch class into one place. This