javadoc complaints

Signed-off-by: Peter Alfonsi <[email protected]>

modules/roaringbitmap-keystore/src/main/java/org/opensearch/cache/KeyStoreStats.java

@@ -17,12 +17,19 @@
  * Getters should be exposed by the KeyLookupStore which uses it.
  */
 public class KeyStoreStats {
+    // Number of entries
     protected CounterMetric size;
+    // Memory cap in bytes
     protected long memSizeCapInBytes;
+    // Number of add attempts
     protected CounterMetric numAddAttempts;
+    // Number of collisions
     protected CounterMetric numCollisions;
+    // True if the store is at capacity
     protected AtomicBoolean atCapacity;
+    // Number of removal attempts
     protected CounterMetric numRemovalAttempts;
+    // Number of successful removal attempts
     protected CounterMetric numSuccessfulRemovals;
 
     protected KeyStoreStats(long memSizeCapInBytes) {

modules/roaringbitmap-keystore/src/main/java/org/opensearch/cache/RBMIntKeyLookupStore.java

@@ -49,16 +49,17 @@ public int getValue() {
         }
     }
 
+    // The modulo applied to values before adding into the RBM
     protected final int modulo;
-    protected final int modulo_bitmask;
+    private final int modulo_bitmask;
     // Since our modulo is always a power of two we can optimize it by ANDing with a particular bitmask
     KeyStoreStats stats;
-    protected RoaringBitmap rbm;
+    private RoaringBitmap rbm;
     private HashMap<Integer, CounterMetric> collidedIntCounters;
     private HashMap<Integer, HashSet<Integer>> removalSets;
-    protected final ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
-    protected final Lock readLock = lock.readLock();
-    protected final Lock writeLock = lock.writeLock();
+    private final ReentrantReadWriteLock lock = new ReentrantReadWriteLock();
+    private final Lock readLock = lock.readLock();
+    private final Lock writeLock = lock.writeLock();
     private long mostRecentByteEstimate;
 
     // Refresh size estimate every X new elements. Refreshes use the RBM's internal size estimator, which takes ~0.01 ms,