You are viewing a plain text version of this content. The canonical link for it is here.
Posted to oak-commits@jackrabbit.apache.org by st...@apache.org on 2012/08/21 11:05:03 UTC

svn commit: r1375435 - /jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

Author: stefan
Date: Tue Aug 21 09:05:02 2012
New Revision: 1375435

URL: http://svn.apache.org/viewvc?rev=1375435&view=rev
Log:
OAK-11 Document and tighten contract of Microkernel API

clarify getLength() and read() if specified blob doesn't exist

Modified:
    jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

Modified: jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
URL: http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java?rev=1375435&r1=1375434&r2=1375435&view=diff
==============================================================================
--- jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java (original)
+++ jackrabbit/oak/trunk/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java Tue Aug 21 09:05:02 2012
@@ -461,7 +461,7 @@ public interface MicroKernel {
      *
      * @param blobId blob identifier
      * @return length of the specified blob
-     * @throws MicroKernelException if an error occurs
+     * @throws MicroKernelException if the specified blob does not exist or if another error occurs
      */
     long getLength(String blobId) throws MicroKernelException;
 
@@ -480,7 +480,7 @@ public interface MicroKernel {
      * @return the total number of bytes read into the buffer, or
      *         {@code -1} if there is no more data because the end of
      *         the blob content has been reached.
-     * @throws MicroKernelException if an error occurs
+     * @throws MicroKernelException if the specified blob does not exist or if another error occurs
      */
     int /* count */ read(String blobId, long pos, byte[] buff, int off, int length)
             throws MicroKernelException;