Fixing Perl Javadoc warnings.

perl/src/main/java/io/perl/api/Channel.java

@@ -9,6 +9,9 @@
  */
 package io.perl.api;
 
+/**
+ * Interface Channel.
+ */
 public non-sealed interface Channel extends GetPerlChannel {
 
     /**

perl/src/main/java/io/perl/api/GetPerlChannel.java

@@ -10,6 +10,9 @@
 
 package io.perl.api;
 
+/**
+ * Interface GetPerlChannel.
+ */
 public sealed interface GetPerlChannel permits Channel, Perl {
 
     /**

perl/src/main/java/io/perl/api/LatencyPercentiles.java

@@ -9,16 +9,56 @@
  */
 package io.perl.api;
 
+/**
+ * Class LatencyPercentiles.
+ */
 final public class LatencyPercentiles {
+
+    /**
+     * <code>public double[] fractions</code>.
+     */
     final public double[] fractions;
+
+    /**
+     * <code>public long[] latencies</code>.
+     */
     final public long[] latencies;
+
+    /**
+     * <code>public long[] latencyIndexes</code>.
+     */
     final public long[] latencyIndexes;
+
+    /**
+     * <code>public long[] latencyCount</code>.
+     */
     final public long[] latencyCount;
+
+    /**
+     * <code>long medianLatency</code>.
+     */
     public long medianLatency;
+
+    /**
+     * <code>long medianLatencyCount</code>.
+     */
     public long medianLatencyCount;
+
+    /**
+     * <code>long medianIndex</code>.
+     */
     public long medianIndex;
+
+    /**
+     * <code>int index</code>.
+     */
     private int index;
 
+    /**
+     * Constructor LatencyPercentiles initializing all values.
+     *
+     * @param percentileFractions double[]
+     */
     public LatencyPercentiles(double[] percentileFractions) {
         this.fractions = percentileFractions;
         this.latencies = new long[this.fractions.length];
@@ -30,6 +70,11 @@ public LatencyPercentiles(double[] percentileFractions) {
         this.index = 0;
     }
 
+    /**
+     * This method reset all records.
+     *
+     * @param totalRecords long
+     */
     public void reset(long totalRecords) {
         for (int i = 0; i < fractions.length; i++) {
             latencyIndexes[i] = (long) (totalRecords * fractions[i]);
@@ -42,6 +87,14 @@ public void reset(long totalRecords) {
         index = 0;
     }
 
+    /**
+     * This method copy Latency.
+     *
+     * @param latency       long
+     * @param count         long
+     * @param startIndex    long
+     * @param endIndex      long
+     */
     public void copyLatency(long latency, long count, long startIndex, long endIndex) {
         if (medianIndex >= startIndex && medianIndex < endIndex) {
             medianLatency = latency;

perl/src/main/java/io/perl/api/LatencyRecord.java

@@ -13,25 +13,63 @@
 import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 
+/**
+ * Sealed Class LatencyRecord.
+ */
 @Slf4j
 abstract public sealed class LatencyRecord permits LatencyRecorder {
+
+    /**
+     * <code>long totalRecords</code>.
+     */
     @Getter
     protected long totalRecords;
+
+    /**
+     * <code>long validLatencyRecords</code>.
+     */
     @Getter
     protected long validLatencyRecords;
+
+    /**
+     * <code>lowerLatencyDiscardRecords</code>.
+     */
     @Getter
     protected long lowerLatencyDiscardRecords;
+
+    /**
+     * <code>long higherLatencyDiscardRecords</code>.
+     */
     @Getter
     protected long higherLatencyDiscardRecords;
+
+    /**
+     * <code>long invalidLatencyRecords</code>.
+     */
     @Getter
     protected long invalidLatencyRecords;
+
+    /**
+     * <code>long totalBytes</code>.
+     */
     @Getter
     protected long totalBytes;
+
+    /**
+     * <code>long totalLatency</code>.
+     */
     @Getter
     protected long totalLatency;
+
+    /**
+     * <code>long maxLatency</code>.
+     */
     @Getter
     protected long maxLatency;
 
+    /**
+     * Method to reset all recording variables.
+     */
     public LatencyRecord() {
         reset();
     }

perl/src/main/java/io/perl/api/LatencyRecordWindow.java

@@ -14,9 +14,23 @@
 import javax.annotation.concurrent.NotThreadSafe;
 
 
+/**
+ * non-sealed Class LatencyRecordWindow.
+ */
 @NotThreadSafe
 public abstract non-sealed class LatencyRecordWindow extends LatencyWindow implements ReportLatency, ReportLatencies {
 
+    /**
+     * Constructor LatencyRecordWindow passing all latencies to it's super class LatencyWindow.
+     *
+     * @param lowLatency                        long
+     * @param highLatency                       long
+     * @param totalLatencyMax                   long
+     * @param totalRecordsMax                   long
+     * @param bytesMax                          long
+     * @param percentilesFractions              double[]
+     * @param time                              Time
+     */
     public LatencyRecordWindow(long lowLatency, long highLatency, long totalLatencyMax, long totalRecordsMax,
                                long bytesMax, double[] percentilesFractions, Time time) {
         super(lowLatency, highLatency, totalLatencyMax, totalRecordsMax, bytesMax, percentilesFractions, time);

perl/src/main/java/io/perl/api/LatencyRecorder.java

@@ -17,12 +17,36 @@
  */
 @NotThreadSafe
 public sealed class LatencyRecorder extends LatencyRecord permits LatencyWindow {
+    /**
+     * <code>long lowLatency</code>.
+     */
     final protected long lowLatency;
+    /**
+     * <code>long highLatency</code>.
+     */
     final protected long highLatency;
+    /**
+     * <code>long totalLatencyMax</code>.
+     */
     final protected long totalLatencyMax;
+    /**
+     * <code>long totalRecordsMax</code>.
+     */
     final protected long totalRecordsMax;
+    /**
+     * <code>long totalBytesMax</code>.
+     */
     final protected long totalBytesMax;
 
+    /**
+     * Constructor LatencyRecorder initializing all values.
+     *
+     * @param baseLatency                       long
+     * @param latencyThreshold                  long
+     * @param totalLatencyMax                   long
+     * @param totalRecordsMax                   long
+     * @param totalBytesMax                     long
+     */
     public LatencyRecorder(long baseLatency, long latencyThreshold, long totalLatencyMax, long totalRecordsMax, long totalBytesMax) {
         super();
         this.lowLatency = baseLatency;

perl/src/main/java/io/perl/api/LatencyWindow.java

@@ -15,13 +15,39 @@
 import io.time.Time;
 import org.jetbrains.annotations.NotNull;
 
+/**
+ * Sealed Class LatencyWindow.
+ */
 abstract public sealed class LatencyWindow extends LatencyRecorder permits LatencyRecordWindow {
+    /**
+     * <code>LatencyPercentiles percentiles</code>.
+     */
     final protected LatencyPercentiles percentiles;
+    /**
+     * <code>Time time</code>.
+     */
     final protected Time time;
+    /**
+     * <code>long[] slc</code>.
+     */
     final private long[] slc;
+    /**
+     * <code>long startTime</code>.
+     */
     private long startTime;
 
 
+    /**
+     * Constructor LatencyWindow to initialize values and pass Latencies to it's super class.
+     *
+     * @param lowLatency                 long
+     * @param highLatency                long
+     * @param totalLatencyMax            long
+     * @param totalRecordsMax            long
+     * @param bytesMax                   long
+     * @param percentilesFractions       double[]
+     * @param time                       Time
+     */
     public LatencyWindow(long lowLatency, long highLatency, long totalLatencyMax, long totalRecordsMax, long bytesMax,
                          double[] percentilesFractions, Time time) {
         super(lowLatency, highLatency, totalLatencyMax, totalRecordsMax, bytesMax);

perl/src/main/java/io/perl/api/ReportLatencies.java

@@ -11,6 +11,9 @@
 package io.perl.api;
 
 
+/**
+ * Interface ReportLatencies.
+ */
 public interface ReportLatencies {
 
     /**

perl/src/main/java/io/perl/api/ReportLatency.java

@@ -9,6 +9,9 @@
  */
 package io.perl.api;
 
+/**
+ * Interface ReportLatency.
+ */
 public interface ReportLatency {
 
 

perl/src/main/java/io/perl/api/TimeStamp.java

@@ -14,26 +14,64 @@
  * class for time stamp including start, end time, bytes and records.
  */
 final public class TimeStamp {
+
+    /**
+     * <code>long startTime</code>.
+     */
     final public long startTime;
+
+    /**
+     * <code>long endTime</code>.
+     */
     final public long endTime;
+
+    /**
+     * <code>int bytes</code>.
+     */
     final public int bytes;
+
+    /**
+     * <code>int records</code>.
+     */
     final public int records;
 
+    /**
+     * Constructor TimeStamp initialize all values.
+     *
+     * @param startTime long
+     * @param endTime   long
+     * @param bytes     int
+     * @param records   int
+     */
     public TimeStamp(long startTime, long endTime, int bytes, int records) {
         this.startTime = startTime;
         this.endTime = endTime;
         this.bytes = bytes;
         this.records = records;
     }
 
+    /**
+     * This Constructor TimeStamp with no arguments initialize all values with 0.
+     */
     public TimeStamp() {
         this(0, 0, 0, 0);
     }
 
+    /**
+     * This Constructor TimeStamp with just one argument, initialize {@link #startTime} = -1
+     * and {@link #endTime} according to the given parameters.
+     *
+     * @param endTime long
+     */
     public TimeStamp(long endTime) {
         this(-1, endTime, 0, 0);
     }
 
+    /**
+     * Checks if it is the end.
+     *
+     * @return true if {@link #startTime} == -1.
+     */
     public boolean isEnd() {
         return this.startTime == -1;
     }

perl/src/main/java/io/perl/api/impl/ArrayLatencyRecorder.java

@@ -29,6 +29,17 @@ final public class ArrayLatencyRecorder extends LatencyRecordWindow {
     private int minIndex;
     private int maxIndex;
 
+    /**
+     * Constructor ArrayLatencyRecorder initialize all values.
+     *
+     * @param lowLatency            long
+     * @param highLatency           long
+     * @param totalLatencyMax       long
+     * @param totalRecordsMax       long
+     * @param bytesMax              long
+     * @param percentiles           double[]
+     * @param time                  Time
+     */
     public ArrayLatencyRecorder(long lowLatency, long highLatency, long totalLatencyMax, long totalRecordsMax,
                                 long bytesMax, double[] percentiles, Time time) {
         super(lowLatency, highLatency, totalLatencyMax, totalRecordsMax, bytesMax, percentiles, time);

perl/src/main/java/io/perl/api/impl/CQueuePerl.java

@@ -49,6 +49,15 @@ final public class CQueuePerl implements Perl {
     private CompletableFuture<Void> qFuture;
 
 
+    /**
+     * Constructor CQueuePerl initialize all values.
+     *
+     * @param perlConfig                NotNull PerlConfig
+     * @param periodicRecorder          PeriodicRecorder
+     * @param reportingIntervalMS       int
+     * @param time                      Time
+     * @param executor                  ExecutorService
+     */
     public CQueuePerl(@NotNull PerlConfig perlConfig, PeriodicRecorder periodicRecorder,
                       int reportingIntervalMS, Time time, ExecutorService executor) {
         int maxQs;
@@ -127,7 +136,7 @@ private void shutdown(Throwable ex) {
      * @param secondsToRun Number of seconds to Run
      * @param recordsCount If secondsToRun is 0, then this indicates the total number of records to benchmark or
      *                     read/write. If secondsToRun is higher than 0, then this parameter is ignored.
-     * @return
+     * @return CompletableFuture retFuture.
      */
     @Override
     @Synchronized