dnaber 2004/08/11 11:59:08
Modified: src/java/org/apache/lucene/index IndexWriter.java
Log:
improve the API doc for getUseCompoundFile()
Revision Changes Path
1.37 +4 -3 jakarta-lucene/src/java/org/apache/lucene/index/IndexWriter.java
Index: IndexWriter.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/index/IndexWriter.java,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -r1.36 -r1.37
--- IndexWriter.java 11 Aug 2004 17:37:52 -0000 1.36
+++ IndexWriter.java 11 Aug 2004 18:59:08 -0000 1.37
@@ -121,9 +121,10 @@
private boolean closeDir;
- /** Setting to turn on usage of a compound file. When on, multiple files
- * for each segment are merged into a single file once the segment creation
- * is finished. This is done regardless of what directory is in use.
+ /** Get the current setting of whether to use the compound file format.
+ * Note that this just returns the value you set with setUseCompoundFile(boolean)
+ * or the default. You cannot use this to query the status of an existing index.
+ * @see #setUseCompoundFile(boolean)
*/
public boolean getUseCompoundFile() {
return useCompoundFile;
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
