Javadocs

Author: thecoop

lucene/core/src/java/org/apache/lucene/util/FloatComparator.java

@@ -18,7 +18,9 @@
 
 import java.util.Comparator;
 
+/** A specialization of {@link Comparator} that compares {@code float} values */
 public interface FloatComparator {
+
   interface ToFloatFunction<T> {
     float applyAsFloat(T obj);
   }
@@ -27,5 +29,10 @@ static <T> Comparator<T> comparing(ToFloatFunction<T> function) {
     return (a, b) -> Float.compare(function.applyAsFloat(a), function.applyAsFloat(b));
   }
 
+  /**
+   * Float-specialized {@link Comparator#compare}
+   *
+   * @see java.util.Comparator#compare
+   */
   int compare(float f1, float f2);
 }

lucene/misc/src/java/org/apache/lucene/misc/search/DiversifiedTopDocsCollector.java

@@ -69,17 +69,16 @@
 public abstract class DiversifiedTopDocsCollector extends TopDocsCollector<ScoreDocKey> {
 
   ScoreDocKey spare;
-  private PriorityQueue<ScoreDocKey> globalQueue;
-  private int numHits;
-  private LongObjectHashMap<PriorityQueue<ScoreDocKey>> perKeyQueues;
+  private final PriorityQueue<ScoreDocKey> globalQueue;
+  private final int numHits;
+  private final LongObjectHashMap<PriorityQueue<ScoreDocKey>> perKeyQueues;
   protected int maxNumPerKey;
-  private Deque<PriorityQueue<ScoreDocKey>> sparePerKeyQueues = new ArrayDeque<>();
+  private final Deque<PriorityQueue<ScoreDocKey>> sparePerKeyQueues = new ArrayDeque<>();
 
   public DiversifiedTopDocsCollector(int numHits, int maxHitsPerKey) {
     super(createScoreDocQueue(numHits));
-    // Need to access pq.lessThan() which is protected so have to cast here...
     this.globalQueue = pq;
-    perKeyQueues = new LongObjectHashMap<>();
+    this.perKeyQueues = new LongObjectHashMap<>();
     this.numHits = numHits;
     this.maxNumPerKey = maxHitsPerKey;
   }