You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ra...@apache.org on 2015/05/13 00:24:14 UTC
curator git commit: updated doc
Repository: curator
Updated Branches:
refs/heads/CURATOR-215 70c35c67e -> f1e6183e4
updated doc
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/f1e6183e
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/f1e6183e
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/f1e6183e
Branch: refs/heads/CURATOR-215
Commit: f1e6183e4ad04f88b39dfe990a48cc86bb188d5b
Parents: 70c35c6
Author: randgalt <ra...@apache.org>
Authored: Tue May 12 17:24:08 2015 -0500
Committer: randgalt <ra...@apache.org>
Committed: Tue May 12 17:24:08 2015 -0500
----------------------------------------------------------------------
.../java/org/apache/curator/framework/CuratorFramework.java | 5 ++++-
.../framework/api/transaction/CuratorMultiTransactionMain.java | 4 ++--
2 files changed, 6 insertions(+), 3 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/f1e6183e/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
index 1bc1535..d56f2ca 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
@@ -22,6 +22,7 @@ package org.apache.curator.framework;
import org.apache.curator.CuratorZookeeperClient;
import org.apache.curator.framework.api.*;
import org.apache.curator.framework.api.transaction.CuratorMultiTransaction;
+import org.apache.curator.framework.api.transaction.CuratorOp;
import org.apache.curator.framework.api.transaction.CuratorTransaction;
import org.apache.curator.framework.api.transaction.TransactionOp;
import org.apache.curator.framework.imps.CuratorFrameworkState;
@@ -152,7 +153,9 @@ public interface CuratorFramework extends Closeable
public CuratorMultiTransaction transaction();
/**
- * Allocate an operation that can be used with {@link #transaction()}
+ * Allocate an operation that can be used with {@link #transaction()}.
+ * NOTE: {@link CuratorOp} instances created by this builder are
+ * reusable.
*
* @return operation builder
*/
http://git-wip-us.apache.org/repos/asf/curator/blob/f1e6183e/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorMultiTransactionMain.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorMultiTransactionMain.java b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorMultiTransactionMain.java
index 77dae61..2425f5b 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorMultiTransactionMain.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorMultiTransactionMain.java
@@ -28,7 +28,7 @@ public interface CuratorMultiTransactionMain
* operation instances via {@link CuratorFramework#transactionOp()}
*
* @param operations operations that make up the transaction.
- * @return result details
+ * @return result details for foreground operations or <code>null</code> for background operations
* @throws Exception errors
*/
List<CuratorTransactionResult> forOperations(CuratorOp... operations) throws Exception;
@@ -38,7 +38,7 @@ public interface CuratorMultiTransactionMain
* operation instances via {@link CuratorFramework#transactionOp()}
*
* @param operations operations that make up the transaction.
- * @return result details
+ * @return result details for foreground operations or <code>null</code> for background operations
* @throws Exception errors
*/
List<CuratorTransactionResult> forOperations(List<CuratorOp> operations) throws Exception;