svn commit: r160277 - incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java

[ju...@apache.org]

Author: jukka
Date: Wed Apr  6 03:06:25 2005
New Revision: 160277

URL: http://svn.apache.org/viewcvs?view=rev&rev=160277
Log:
JCR-73: Improved FileSystem javadocs.

Modified:
    incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java

Modified: incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java
URL: http://svn.apache.org/viewcvs/incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java?view=diff&r1=160276&r2=160277
==============================================================================
--- incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java (original)
+++ incubator/jackrabbit/trunk/src/java/org/apache/jackrabbit/core/fs/FileSystem.java Wed Apr  6 03:06:25 2005
@@ -43,7 +43,7 @@
     /**
      * Initialize the file system
      *
-     * @throws FileSystemException
+     * @throws FileSystemException if the file system initialization fails
      */
     public void init() throws FileSystemException;
 
@@ -60,7 +60,8 @@
      *
      * @param filePath the path of the file.
      * @return an input stream of the contents of the file.
-     * @throws FileSystemException
+     * @throws FileSystemException if the file does not exist
+     *                             or if it cannot be read from
      */
     public InputStream getInputStream(String filePath) throws FileSystemException;
 
@@ -71,7 +72,7 @@
      *
      * @param filePath the path of the file.
      * @return an output stream for writing bytes to the file.
-     * @throws FileSystemException
+     * @throws FileSystemException if the file cannot be written to or created
      */
     public OutputStream getOutputStream(String filePath) throws FileSystemException;
 
@@ -90,7 +91,7 @@
      *                                      {@link RandomAccessOutputStream}.
      */
     public RandomAccessOutputStream getRandomAccessOutputStream(String filePath)
-            throws FileSystemException;
+            throws FileSystemException, UnsupportedOperationException;
 
     /**
      * Creates the folder named by this path, including any necessary but
@@ -230,7 +231,7 @@
      *
      * @param srcPath  the path of the file or folder to be moved.
      * @param destPath the destination path to which the file or folder is to be moved.
-     * @throws FileSystemException
+     * @throws FileSystemException if the move fails
      */
     public void move(String srcPath, String destPath) throws FileSystemException;
 
@@ -239,7 +240,7 @@
      *
      * @param srcPath  the path of the file or folder to be copied.
      * @param destPath the destination path to which the file or folder is to be copied.
-     * @throws FileSystemException
+     * @throws FileSystemException if the copy fails
      */
     public void copy(String srcPath, String destPath) throws FileSystemException;