dnaber 2004/08/25 16:34:17
Modified: src/java/org/apache/lucene/index CompoundFileReader.java
Log:
improve API documentation a bit
Revision Changes Path
1.12 +11 -11
jakarta-lucene/src/java/org/apache/lucene/index/CompoundFileReader.java
Index: CompoundFileReader.java
===================================================================
RCS file:
/home/cvs/jakarta-lucene/src/java/org/apache/lucene/index/CompoundFileReader.java,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- CompoundFileReader.java 17 Aug 2004 20:59:23 -0000 1.11
+++ CompoundFileReader.java 25 Aug 2004 23:34:17 -0000 1.12
@@ -143,21 +143,22 @@
directory.touchFile(fileName);
}
- /** Removes an existing file in the directory. */
+ /** Not implemented
+ * @throws UnsupportedOperationException */
public void deleteFile(String name)
{
throw new UnsupportedOperationException();
}
- /** Renames an existing file in the directory.
- If a file already exists with the new name, then it is replaced.
- This replacement should be atomic. */
+ /** Not implemented
+ * @throws UnsupportedOperationException */
public void renameFile(String from, String to)
{
throw new UnsupportedOperationException();
}
- /** Returns the length of a file in the directory. */
+ /** Returns the length of a file in the directory.
+ * @throws IOException if the file does not exist */
public long fileLength(String name)
throws IOException
{
@@ -167,16 +168,15 @@
return e.length;
}
- /** Creates a new, empty file in the directory with the given name.
- Returns a stream writing this file. */
+ /** Not implemented
+ * @throws UnsupportedOperationException */
public OutputStream createFile(String name)
{
throw new UnsupportedOperationException();
}
- /** Construct a [EMAIL PROTECTED] Lock}.
- * @param name the name of the lock file
- */
+ /** Not implemented
+ * @throws UnsupportedOperationException */
public Lock makeLock(String name)
{
throw new UnsupportedOperationException();
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
