commit 681975d6e85a39dd7ec9257a8466d9b83cef7d49
author Greg Miller <gsmiller@gmail.com> Fri Oct 13 07:03:24 2023 -0700
committer GitHub <noreply@github.com> Fri Oct 13 07:03:24 2023 -0700
tree 12d737904b38a0417c209ccc567140f8a222de94
parent afc990cd2b43cb4731744ca867fb13173fd76dc8

Add javadoc note to LeafCollector#finish (#12643)

lucene/core/src/java/org/apache/lucene/search/LeafCollector.java

diff --git a/lucene/core/src/java/org/apache/lucene/search/LeafCollector.java b/lucene/core/src/java/org/apache/lucene/search/LeafCollector.java
index ec387ca..2cc9d5c 100644
--- a/lucene/core/src/java/org/apache/lucene/search/LeafCollector.java
+++ b/lucene/core/src/java/org/apache/lucene/search/LeafCollector.java
@@ -125,6 +125,9 @@
    * is typically useful to compile data that has been collected on this leaf, e.g. to convert facet
    * counts on leaf ordinals to facet counts on global ordinals. The default implementation does
    * nothing.
+   *
+   * <p>Note: It can be assumed that this method will only be called once per LeafCollector
+   * instance.
    */
   default void finish() throws IOException {}
 }