lucene-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dna...@apache.org
Subject cvs commit: jakarta-lucene/src/java/org/apache/lucene/index CompoundFileWriter.java
Date Fri, 13 Aug 2004 19:54:36 GMT
dnaber      2004/08/13 12:54:36

  Modified:    src/java/org/apache/lucene/index CompoundFileWriter.java
  Log:
  fix the documentation for addFile()
  
  Revision  Changes    Path
  1.4       +7 -6      jakarta-lucene/src/java/org/apache/lucene/index/CompoundFileWriter.java
  
  Index: CompoundFileWriter.java
  ===================================================================
  RCS file: /home/cvs/jakarta-lucene/src/java/org/apache/lucene/index/CompoundFileWriter.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- CompoundFileWriter.java	29 Mar 2004 22:48:02 -0000	1.3
  +++ CompoundFileWriter.java	13 Aug 2004 19:54:36 -0000	1.4
  @@ -94,11 +94,12 @@
           return fileName;
       }
   
  -    /** Add a source stream. If sourceDir is null, it is set to the
  -     *  same value as the directory where this compound stream exists.
  -     *  The id is the string by which the sub-stream will be know in the
  -     *  compound stream. The caller must ensure that the ID is unique. If the
  -     *  id is null, it is set to the name of the source file.
  +    /** Add a source stream. <code>file</code> is the string by which the 
  +     *  sub-stream will be known in the compound stream.
  +     * 
  +     *  @throws IllegalStateException if this writer is closed
  +     *  @throws IllegalArgumentException if <code>file</code> is null
  +     *   or if a file with the same name has been added already
        */
       public void addFile(String file) {
           if (merged)
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: lucene-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: lucene-dev-help@jakarta.apache.org


Mime
View raw message