LUCENE-9998: delete useless param fis in StoredFieldsWriter.finish() and TermVectorsWriter.finish() (#183)

kkewwei · web-flow · commit b7b834b75681 · 2021-06-15T16:59:42.000+02:00
diff --git a/lucene/CHANGES.txt b/lucene/CHANGES.txt
@@ -127,6 +127,9 @@ API Changes
 
 * LUCENE-8143: SpanBoostQuery has been removed. (Alan Woodward)
 
+* LUCENE-9998: Remove unused parameter fis in StoredFieldsWriter.finish() and TermVectorsWriter.finish(),
+  including those subclasses. (kkewwei)
+
 Improvements
 
 * LUCENE-9960: Avoid unnecessary top element replacement for equal elements in PriorityQueue. (Dawid Weiss)
diff --git a/lucene/backward-codecs/src/test/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsWriter.java b/lucene/backward-codecs/src/test/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingStoredFieldsWriter.java
@@ -36,7 +36,6 @@
 import org.apache.lucene.codecs.compressing.CompressionMode;
 import org.apache.lucene.codecs.compressing.Compressor;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.IndexableField;
 import org.apache.lucene.index.SegmentInfo;
@@ -480,7 +479,7 @@ static void writeTLong(DataOutput out, long l) throws IOException {
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (numBufferedDocs > 0) {
       flush(true);
     } else {
diff --git a/lucene/backward-codecs/src/test/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsWriter.java b/lucene/backward-codecs/src/test/org/apache/lucene/backward_codecs/lucene50/compressing/Lucene50CompressingTermVectorsWriter.java
@@ -42,7 +42,6 @@
 import org.apache.lucene.codecs.compressing.CompressionMode;
 import org.apache.lucene.codecs.compressing.Compressor;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.SegmentInfo;
 import org.apache.lucene.store.ByteBuffersDataOutput;
@@ -701,7 +700,7 @@ private void flushPayloadLengths() throws IOException {
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (!pendingDocs.isEmpty()) {
       numDirtyChunks++; // incomplete: we had to force this flush
       numDirtyDocs += pendingDocs.size();
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextStoredFieldsWriter.java b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextStoredFieldsWriter.java
@@ -19,7 +19,6 @@
 import java.io.IOException;
 import org.apache.lucene.codecs.StoredFieldsWriter;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.IndexableField;
 import org.apache.lucene.store.Directory;
@@ -152,7 +151,7 @@ public void writeField(FieldInfo info, IndexableField field) throws IOException
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (numDocsWritten != numDocs) {
       throw new RuntimeException(
           "mergeFields produced an invalid result: docCount is "
diff --git a/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsWriter.java b/lucene/codecs/src/java/org/apache/lucene/codecs/simpletext/SimpleTextTermVectorsWriter.java
@@ -19,7 +19,6 @@
 import java.io.IOException;
 import org.apache.lucene.codecs.TermVectorsWriter;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.store.Directory;
 import org.apache.lucene.store.IOContext;
@@ -165,7 +164,7 @@ public void addPosition(int position, int startOffset, int endOffset, BytesRef p
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (numDocsWritten != numDocs) {
       throw new RuntimeException(
           "mergeVectors produced an invalid result: mergedDocs is "
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/StoredFieldsWriter.java
@@ -44,7 +44,7 @@
  *   <li>For every document, {@link #startDocument()} is called, informing the Codec that a new
  *       document has started.
  *   <li>{@link #writeField(FieldInfo, IndexableField)} is called for each field in the document.
- *   <li>After all documents have been written, {@link #finish(FieldInfos, int)} is called for
+ *   <li>After all documents have been written, {@link #finish(int)} is called for
  *       verification/sanity-checks.
  *   <li>Finally the writer is closed ({@link #close()})
  * </ol>
@@ -74,7 +74,7 @@ public void finishDocument() throws IOException {}
    * this is intentionally redundant (equivalent to the number of calls to {@link #startDocument()},
    * but a Codec should check that this is the case to detect the JRE bug described in LUCENE-1282.
    */
-  public abstract void finish(FieldInfos fis, int numDocs) throws IOException;
+  public abstract void finish(int numDocs) throws IOException;
 
   private static class StoredFieldsMergeSub extends DocIDMerger.Sub {
     private final StoredFieldsReader reader;
@@ -104,9 +104,9 @@ public int nextDoc() {
   /**
    * Merges in the stored fields from the readers in <code>mergeState</code>. The default
    * implementation skips over deleted documents, and uses {@link #startDocument()}, {@link
-   * #writeField(FieldInfo, IndexableField)}, and {@link #finish(FieldInfos, int)}, returning the
-   * number of documents that were written. Implementations can override this method for more
-   * sophisticated merging (bulk-byte copying, etc).
+   * #writeField(FieldInfo, IndexableField)}, and {@link #finish(int)}, returning the number of
+   * documents that were written. Implementations can override this method for more sophisticated
+   * merging (bulk-byte copying, etc).
    */
   public int merge(MergeState mergeState) throws IOException {
     List<StoredFieldsMergeSub> subs = new ArrayList<>();
@@ -136,7 +136,7 @@ public int merge(MergeState mergeState) throws IOException {
       finishDocument();
       docCount++;
     }
-    finish(mergeState.mergeFieldInfos, docCount);
+    finish(docCount);
     return docCount;
   }
 
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/TermVectorsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/TermVectorsWriter.java
@@ -25,7 +25,6 @@
 import java.util.List;
 import org.apache.lucene.index.DocIDMerger;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.Fields;
 import org.apache.lucene.index.MergeState;
 import org.apache.lucene.index.PostingsEnum;
@@ -49,7 +48,7 @@
  *   <li>Within each field, {@link #startTerm(BytesRef, int)} is called for each term.
  *   <li>If offsets and/or positions are enabled, then {@link #addPosition(int, int, int, BytesRef)}
  *       will be called for each term occurrence.
- *   <li>After all documents have been written, {@link #finish(FieldInfos, int)} is called for
+ *   <li>After all documents have been written, {@link #finish(int)} is called for
  *       verification/sanity-checks.
  *   <li>Finally the writer is closed ({@link #close()})
  * </ol>
@@ -105,7 +104,7 @@ public abstract void addPosition(int position, int startOffset, int endOffset, B
    * #startDocument(int)}, but a Codec should check that this is the case to detect the JRE bug
    * described in LUCENE-1282.
    */
-  public abstract void finish(FieldInfos fis, int numDocs) throws IOException;
+  public abstract void finish(int numDocs) throws IOException;
 
   /**
    * Called by IndexWriter when writing new segments.
@@ -193,9 +192,9 @@ public int nextDoc() {
    * Merges in the term vectors from the readers in <code>mergeState</code>. The default
    * implementation skips over deleted documents, and uses {@link #startDocument(int)}, {@link
    * #startField(FieldInfo, int, boolean, boolean, boolean)}, {@link #startTerm(BytesRef, int)},
-   * {@link #addPosition(int, int, int, BytesRef)}, and {@link #finish(FieldInfos, int)}, returning
-   * the number of documents that were written. Implementations can override this method for more
-   * sophisticated merging (bulk-byte copying, etc).
+   * {@link #addPosition(int, int, int, BytesRef)}, and {@link #finish(int)}, returning the number
+   * of documents that were written. Implementations can override this method for more sophisticated
+   * merging (bulk-byte copying, etc).
    */
   public int merge(MergeState mergeState) throws IOException {
 
@@ -229,7 +228,7 @@ public int merge(MergeState mergeState) throws IOException {
       addAllDocVectors(vectors, mergeState);
       docCount++;
     }
-    finish(mergeState.mergeFieldInfos, docCount);
+    finish(docCount);
     return docCount;
   }
 
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingStoredFieldsWriter.java
@@ -31,7 +31,6 @@
 import org.apache.lucene.index.CorruptIndexException;
 import org.apache.lucene.index.DocIDMerger;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.IndexableField;
 import org.apache.lucene.index.MergeState;
@@ -478,7 +477,7 @@ static void writeTLong(DataOutput out, long l) throws IOException {
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (numBufferedDocs > 0) {
       flush(true);
     } else {
@@ -654,7 +653,7 @@ public int merge(MergeState mergeState) throws IOException {
         throw new AssertionError("Unknown merge strategy [" + sub.mergeStrategy + "]");
       }
     }
-    finish(mergeState.mergeFieldInfos, docCount);
+    finish(docCount);
     return docCount;
   }
 
diff --git a/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsWriter.java b/lucene/core/src/java/org/apache/lucene/codecs/lucene90/compressing/Lucene90CompressingTermVectorsWriter.java
@@ -37,7 +37,6 @@
 import org.apache.lucene.index.CorruptIndexException;
 import org.apache.lucene.index.DocIDMerger;
 import org.apache.lucene.index.FieldInfo;
-import org.apache.lucene.index.FieldInfos;
 import org.apache.lucene.index.Fields;
 import org.apache.lucene.index.IndexFileNames;
 import org.apache.lucene.index.MergeState;
@@ -721,7 +720,7 @@ private void flushPayloadLengths() throws IOException {
   }
 
   @Override
-  public void finish(FieldInfos fis, int numDocs) throws IOException {
+  public void finish(int numDocs) throws IOException {
     if (!pendingDocs.isEmpty()) {
       flush(true);
     }
@@ -939,7 +938,7 @@ public int merge(MergeState mergeState) throws IOException {
         sub = docIDMerger.next();
       }
     }
-    finish(mergeState.mergeFieldInfos, docCount);
+    finish(docCount);
     return docCount;
   }
 
diff --git a/lucene/core/src/java/org/apache/lucene/index/SortingStoredFieldsConsumer.java b/lucene/core/src/java/org/apache/lucene/index/SortingStoredFieldsConsumer.java
@@ -115,7 +115,7 @@ void flush(SegmentWriteState state, Sorter.DocMap sortMap) throws IOException {
         reader.visitDocument(sortMap == null ? docID : sortMap.newToOld(docID), visitor);
         sortWriter.finishDocument();
       }
-      sortWriter.finish(state.fieldInfos, state.segmentInfo.maxDoc());
+      sortWriter.finish(state.segmentInfo.maxDoc());
     } finally {
       IOUtils.close(reader, sortWriter);
       IOUtils.deleteFiles(tmpDirectory, tmpDirectory.getTemporaryFiles().values());
diff --git a/lucene/core/src/java/org/apache/lucene/index/SortingTermVectorsConsumer.java b/lucene/core/src/java/org/apache/lucene/index/SortingTermVectorsConsumer.java
@@ -75,7 +75,7 @@ void flush(
           Fields vectors = reader.get(sortMap == null ? docID : sortMap.newToOld(docID));
           writeTermVectors(writer, vectors, state.fieldInfos);
         }
-        writer.finish(state.fieldInfos, state.segmentInfo.maxDoc());
+        writer.finish(state.segmentInfo.maxDoc());
       } finally {
         IOUtils.close(reader, writer);
         IOUtils.deleteFiles(tmpDirectory, tmpDirectory.getTemporaryFiles().values());
diff --git a/lucene/core/src/java/org/apache/lucene/index/StoredFieldsConsumer.java b/lucene/core/src/java/org/apache/lucene/index/StoredFieldsConsumer.java
@@ -79,7 +79,7 @@ void finish(int maxDoc) throws IOException {
 
   void flush(SegmentWriteState state, Sorter.DocMap sortMap) throws IOException {
     try {
-      writer.finish(state.fieldInfos, state.segmentInfo.maxDoc());
+      writer.finish(state.segmentInfo.maxDoc());
     } finally {
       IOUtils.close(writer);
     }
diff --git a/lucene/core/src/java/org/apache/lucene/index/TermVectorsConsumer.java b/lucene/core/src/java/org/apache/lucene/index/TermVectorsConsumer.java
@@ -82,7 +82,7 @@ void flush(
       try {
         fill(numDocs);
         assert state.segmentInfo != null;
-        writer.finish(state.fieldInfos, numDocs);
+        writer.finish(numDocs);
       } finally {
         IOUtils.close(writer);
       }
diff --git a/lucene/test-framework/src/java/org/apache/lucene/codecs/asserting/AssertingStoredFieldsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/codecs/asserting/AssertingStoredFieldsFormat.java
@@ -136,9 +136,9 @@ public void writeField(FieldInfo info, IndexableField field) throws IOException
     }
 
     @Override
-    public void finish(FieldInfos fis, int numDocs) throws IOException {
+    public void finish(int numDocs) throws IOException {
       assert docStatus == (numDocs > 0 ? Status.FINISHED : Status.UNDEFINED);
-      in.finish(fis, numDocs);
+      in.finish(numDocs);
       assert numDocs == numWritten;
     }
 
diff --git a/lucene/test-framework/src/java/org/apache/lucene/codecs/asserting/AssertingTermVectorsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/codecs/asserting/AssertingTermVectorsFormat.java
@@ -185,12 +185,12 @@ public void addPosition(int position, int startOffset, int endOffset, BytesRef p
     }
 
     @Override
-    public void finish(FieldInfos fis, int numDocs) throws IOException {
+    public void finish(int numDocs) throws IOException {
       assert docCount == numDocs;
       assert docStatus == (numDocs > 0 ? Status.FINISHED : Status.UNDEFINED);
       assert fieldStatus != Status.STARTED;
       assert termStatus != Status.STARTED;
-      in.finish(fis, numDocs);
+      in.finish(numDocs);
     }
 
     @Override
diff --git a/lucene/test-framework/src/java/org/apache/lucene/codecs/cranky/CrankyStoredFieldsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/codecs/cranky/CrankyStoredFieldsFormat.java
@@ -66,11 +66,11 @@ static class CrankyStoredFieldsWriter extends StoredFieldsWriter {
     }
 
     @Override
-    public void finish(FieldInfos fis, int numDocs) throws IOException {
+    public void finish(int numDocs) throws IOException {
       if (random.nextInt(100) == 0) {
         throw new IOException("Fake IOException from StoredFieldsWriter.finish()");
       }
-      delegate.finish(fis, numDocs);
+      delegate.finish(numDocs);
     }
 
     @Override
diff --git a/lucene/test-framework/src/java/org/apache/lucene/codecs/cranky/CrankyTermVectorsFormat.java b/lucene/test-framework/src/java/org/apache/lucene/codecs/cranky/CrankyTermVectorsFormat.java
@@ -77,11 +77,11 @@ public int merge(MergeState mergeState) throws IOException {
     }
 
     @Override
-    public void finish(FieldInfos fis, int numDocs) throws IOException {
+    public void finish(int numDocs) throws IOException {
       if (random.nextInt(100) == 0) {
         throw new IOException("Fake IOException from TermVectorsWriter.finish()");
       }
-      delegate.finish(fis, numDocs);
+      delegate.finish(numDocs);
     }
 
     @Override
diff --git a/lucene/test-framework/src/java/org/apache/lucene/index/BaseIndexFileFormatTestCase.java b/lucene/test-framework/src/java/org/apache/lucene/index/BaseIndexFileFormatTestCase.java
@@ -529,7 +529,7 @@ public void close() {}
       consumer.finishTerm();
       consumer.finishField();
       consumer.finishDocument();
-      consumer.finish(fieldInfos, 1);
+      consumer.finish(1);
       IOUtils.close(consumer);
       IOUtils.close(consumer);
     }
@@ -545,7 +545,7 @@ public void close() {}
       consumer.startDocument();
       consumer.writeField(field, customField);
       consumer.finishDocument();
-      consumer.finish(fieldInfos, 1);
+      consumer.finish(1);
       IOUtils.close(consumer);
       IOUtils.close(consumer);
     }

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,6 @@`
`31`	`31`	`import org.apache.lucene.index.CorruptIndexException;`
`32`	`32`	`import org.apache.lucene.index.DocIDMerger;`
`33`	`33`	`import org.apache.lucene.index.FieldInfo;`
`34`		`-import org.apache.lucene.index.FieldInfos;`
`35`	`34`	`import org.apache.lucene.index.IndexFileNames;`
`36`	`35`	`import org.apache.lucene.index.IndexableField;`
`37`	`36`	`import org.apache.lucene.index.MergeState;`
`@@ -478,7 +477,7 @@ static void writeTLong(DataOutput out, long l) throws IOException {`
`478`	`477`	`}`
`479`	`478`
`480`	`479`	`@Override`
`481`		`- public void finish(FieldInfos fis, int numDocs) throws IOException {`
	`480`	`+ public void finish(int numDocs) throws IOException {`
`482`	`481`	`if (numBufferedDocs > 0) {`
`483`	`482`	`flush(true);`
`484`	`483`	`} else {`
`@@ -654,7 +653,7 @@ public int merge(MergeState mergeState) throws IOException {`
`654`	`653`	`throw new AssertionError("Unknown merge strategy [" + sub.mergeStrategy + "]");`
`655`	`654`	`}`
`656`	`655`	`}`
`657`		`- finish(mergeState.mergeFieldInfos, docCount);`
	`656`	`+ finish(docCount);`
`658`	`657`	`return docCount;`
`659`	`658`	`}`
`660`	`659`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,6 @@`
`37`	`37`	`import org.apache.lucene.index.CorruptIndexException;`
`38`	`38`	`import org.apache.lucene.index.DocIDMerger;`
`39`	`39`	`import org.apache.lucene.index.FieldInfo;`
`40`		`-import org.apache.lucene.index.FieldInfos;`
`41`	`40`	`import org.apache.lucene.index.Fields;`
`42`	`41`	`import org.apache.lucene.index.IndexFileNames;`
`43`	`42`	`import org.apache.lucene.index.MergeState;`
`@@ -721,7 +720,7 @@ private void flushPayloadLengths() throws IOException {`
`721`	`720`	`}`
`722`	`721`
`723`	`722`	`@Override`
`724`		`- public void finish(FieldInfos fis, int numDocs) throws IOException {`
	`723`	`+ public void finish(int numDocs) throws IOException {`
`725`	`724`	`if (!pendingDocs.isEmpty()) {`
`726`	`725`	`flush(true);`
`727`	`726`	`}`
`@@ -939,7 +938,7 @@ public int merge(MergeState mergeState) throws IOException {`
`939`	`938`	`sub = docIDMerger.next();`
`940`	`939`	`}`
`941`	`940`	`}`
`942`		`- finish(mergeState.mergeFieldInfos, docCount);`
	`941`	`+ finish(docCount);`
`943`	`942`	`return docCount;`
`944`	`943`	`}`
`945`	`944`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ void flush(SegmentWriteState state, Sorter.DocMap sortMap) throws IOException {`
`115`	`115`	`reader.visitDocument(sortMap == null ? docID : sortMap.newToOld(docID), visitor);`
`116`	`116`	`sortWriter.finishDocument();`
`117`	`117`	`}`
`118`		`- sortWriter.finish(state.fieldInfos, state.segmentInfo.maxDoc());`
	`118`	`+ sortWriter.finish(state.segmentInfo.maxDoc());`
`119`	`119`	`} finally {`
`120`	`120`	`IOUtils.close(reader, sortWriter);`
`121`	`121`	`IOUtils.deleteFiles(tmpDirectory, tmpDirectory.getTemporaryFiles().values());`