LUCENE-10477: mention 'call multiple times' in Query.rewrite javadoc (#…

…758)
apache · Mar 22, 2022 · 779c332 · 779c332
1 parent 04127ed
commit 779c332
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/lucene/core/src/java/org/apache/lucene/search/Query.java b/lucene/core/src/java/org/apache/lucene/search/Query.java
@@ -73,6 +73,11 @@ public Weight createWeight(IndexSearcher searcher, ScoreMode scoreMode, float bo
   /**
    * Expert: called to re-write queries into primitive queries. For example, a PrefixQuery will be
    * rewritten into a BooleanQuery that consists of TermQuerys.
+   *
+   * <p>Callers are expected to call <code>rewrite</code> multiple times if necessary, until the
+   * rewritten query is the same as the original query.
+   *
+   * @see IndexSearcher#rewrite(Query)
    */
   public Query rewrite(IndexReader reader) throws IOException {
     return this;