From 213904a810481e5e0dba53ff8ca3fda2bd4c10c3 Mon Sep 17 00:00:00 2001 From: Daniel Naber Date: Fri, 13 Aug 2004 19:54:36 +0000 Subject: [PATCH] fix the documentation for addFile() git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@150425 13f79535-47bb-0310-9956-ffa450edef68 --- .../org/apache/lucene/index/CompoundFileWriter.java | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/src/java/org/apache/lucene/index/CompoundFileWriter.java b/src/java/org/apache/lucene/index/CompoundFileWriter.java index cf14c15e15d..6cc6d77ba33 100644 --- a/src/java/org/apache/lucene/index/CompoundFileWriter.java +++ b/src/java/org/apache/lucene/index/CompoundFileWriter.java @@ -94,11 +94,12 @@ final class CompoundFileWriter { 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. file 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 file is null + * or if a file with the same name has been added already */ public void addFile(String file) { if (merged)