You are viewing a plain text version of this content. The canonical link for it is here.
Posted to slide-dev@jakarta.apache.org by re...@locus.apache.org on 2000/12/04 02:58:59 UTC
cvs commit: jakarta-slide/src/share/org/apache/slide/store ContentStore.java
remm 00/12/03 17:58:59
Modified: src/share/org/apache/slide/store ContentStore.java
Log:
- Document the new requirements for ContentStore implementation in
the ContentStore JavaDoc.
Revision Changes Path
1.3 +34 -8 jakarta-slide/src/share/org/apache/slide/store/ContentStore.java
Index: ContentStore.java
===================================================================
RCS file: /home/cvs/jakarta-slide/src/share/org/apache/slide/store/ContentStore.java,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- ContentStore.java 2000/09/26 02:44:21 1.2
+++ ContentStore.java 2000/12/04 01:58:59 1.3
@@ -1,7 +1,7 @@
/*
- * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/store/ContentStore.java,v 1.2 2000/09/26 02:44:21 remm Exp $
- * $Revision: 1.2 $
- * $Date: 2000/09/26 02:44:21 $
+ * $Header: /home/cvs/jakarta-slide/src/share/org/apache/slide/store/ContentStore.java,v 1.3 2000/12/04 01:58:59 remm Exp $
+ * $Revision: 1.3 $
+ * $Date: 2000/12/04 01:58:59 $
*
* ====================================================================
*
@@ -76,7 +76,7 @@
* Store service.
*
* @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
- * @version $Revision: 1.2 $
+ * @version $Revision: 1.3 $
*/
public interface ContentStore extends Service {
@@ -85,7 +85,7 @@
/**
- * Retrive revision content.
+ * Retrieve revision content.
*
* @param uri Uri
* @param revisionNumber Node revision number
@@ -96,7 +96,20 @@
/**
- * Create a new revision
+ * Create revision content.
+ * <p>
+ * Notes:
+ * <ul>
+ * <li>If a content length is specified by the revisionDescriptor
+ * (ie, revisionDescriptor.getContentLength != -1), then
+ * the ContentStore MUST enforce it, and throw a ServiceAccessException
+ * if an incorrect number of bytes are read. It MUST also revert any
+ * changes made to the unedrlying repository.</li>
+ * <li>If a content length is not specified by the revisionDescriptor
+ * (ie, revisionDescriptor.getContentLength == -1), then the ContentStore
+ * MUST read all the bytes available and then call
+ * revisionDescriptor.setContentLength(numberOfBytesRead).</li>
+ * </ul>
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
@@ -109,7 +122,20 @@
/**
- * Modify the latest revision of an object.
+ * Modify revision content.
+ * <p>
+ * Notes:
+ * <ul>
+ * <li>If a content length is specified by the revisionDescriptor
+ * (ie, revisionDescriptor.getContentLength != -1), then
+ * the ContentStore MUST enforce it, and throw a ServiceAccessException
+ * if an incorrect number of bytes are read. It MUST also revert any
+ * changes made to the unedrlying repository.</li>
+ * <li>If a content length is not specified by the revisionDescriptor
+ * (ie, revisionDescriptor.getContentLength == -1), then the ContentStore
+ * MUST read all the bytes available and then call
+ * revisionDescriptor.setContentLength(numberOfBytesRead).</li>
+ * </ul>
*
* @param uri Uri
* @param revisionDescriptor Node revision descriptor
@@ -122,7 +148,7 @@
/**
- * Remove revision.
+ * Remove revision content.
*
* @param uri Uri
* @param revisionNumber Node revision number