fix the documentation for addFile()

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150425 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Daniel Naber 2004-08-13 19:54:36 +00:00
parent cf7e09486d
commit 213904a810
1 changed files with 6 additions and 5 deletions

View File

@ -94,11 +94,12 @@ final class CompoundFileWriter {
return fileName; return fileName;
} }
/** Add a source stream. If sourceDir is null, it is set to the /** Add a source stream. <code>file</code> is the string by which the
* same value as the directory where this compound stream exists. * sub-stream will be known in the compound stream.
* 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 * @throws IllegalStateException if this writer is closed
* id is null, it is set to the name of the source file. * @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) { public void addFile(String file) {
if (merged) if (merged)