Author: mreutegg
Date: Thu May 22 14:23:56 2014
New Revision: 1596889
URL: http://svn.apache.org/r1596889
Log:
OAK-1266 - documentation
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentStore.java
Modified:
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentStore.java
URL:
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentStore.java?rev=1596889&r1=1596888&r2=1596889&view=diff
==============================================================================
---
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentStore.java
(original)
+++
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentStore.java
Thu May 22 14:23:56 2014
@@ -136,7 +136,16 @@ public interface DocumentStore {
<T extends Document> void remove(Collection<T> collection, List<String>
keys);
/**
- * Try to create a list of documents.
+ * Try to create a list of documents. This method returns {@code code} iff
+ * none of the documents existed before and the create was successful. This
+ * method will return {@code false} if one of the documents already exists
+ * in the store. Some documents may still have been created in the store.
+ * An implementation does not have to guarantee an atomic create of all the
+ * documents described in the {@code updateOps}. It is the responsibility
of
+ * the caller to check, which documents were created and take appropriate
+ * action. The same is true when this method throws an exception (e.g. when
+ * a communication error occurs). In this case only some documents may have
+ * been created.
*
* @param <T> the document type
* @param collection the collection
