You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by dr...@apache.org on 2015/08/17 18:54:51 UTC
[21/27] curator git commit: added doc
added doc
Project: http://git-wip-us.apache.org/repos/asf/curator/repo
Commit: http://git-wip-us.apache.org/repos/asf/curator/commit/eacb0ba1
Tree: http://git-wip-us.apache.org/repos/asf/curator/tree/eacb0ba1
Diff: http://git-wip-us.apache.org/repos/asf/curator/diff/eacb0ba1
Branch: refs/heads/CURATOR-215
Commit: eacb0ba1e392267648c004f81455573bbc586a87
Parents: 7df5ab3
Author: randgalt <ra...@apache.org>
Authored: Sat May 9 15:01:20 2015 -0500
Committer: Scott Blum <dr...@apache.org>
Committed: Wed Aug 12 17:29:42 2015 -0400
----------------------------------------------------------------------
.../CuratorMultiTransactionMain.java | 17 +++++++++++++
.../framework/api/transaction/CuratorOp.java | 3 +++
.../api/transaction/CuratorTransaction.java | 2 +-
.../api/transaction/TransactionOp.java | 26 ++++++++++++++++++++
4 files changed, 47 insertions(+), 1 deletion(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/curator/blob/eacb0ba1/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 6b4910d..77dae61 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
@@ -18,11 +18,28 @@
*/
package org.apache.curator.framework.api.transaction;
+import org.apache.curator.framework.CuratorFramework;
import java.util.List;
public interface CuratorMultiTransactionMain
{
+ /**
+ * Commit the given operations as a single transaction. Create the
+ * operation instances via {@link CuratorFramework#transactionOp()}
+ *
+ * @param operations operations that make up the transaction.
+ * @return result details
+ * @throws Exception errors
+ */
List<CuratorTransactionResult> forOperations(CuratorOp... operations) throws Exception;
+ /**
+ * Commit the given operations as a single transaction. Create the
+ * operation instances via {@link CuratorFramework#transactionOp()}
+ *
+ * @param operations operations that make up the transaction.
+ * @return result details
+ * @throws Exception errors
+ */
List<CuratorTransactionResult> forOperations(List<CuratorOp> operations) throws Exception;
}
http://git-wip-us.apache.org/repos/asf/curator/blob/eacb0ba1/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorOp.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorOp.java b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorOp.java
index 533226b..23bc76c 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorOp.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorOp.java
@@ -20,6 +20,9 @@ package org.apache.curator.framework.api.transaction;
import org.apache.zookeeper.Op;
+/**
+ * Internal representation of a transaction operation
+ */
public interface CuratorOp
{
Op get();
http://git-wip-us.apache.org/repos/asf/curator/blob/eacb0ba1/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorTransaction.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorTransaction.java b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorTransaction.java
index 4f2fb02..5d60b5c 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorTransaction.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/CuratorTransaction.java
@@ -78,7 +78,7 @@ public interface CuratorTransaction
/**
* Start a check builder in the transaction
- *ChildData
+ *
* @return builder object
*/
public TransactionCheckBuilder<CuratorTransactionBridge> check();
http://git-wip-us.apache.org/repos/asf/curator/blob/eacb0ba1/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/TransactionOp.java
----------------------------------------------------------------------
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/TransactionOp.java b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/TransactionOp.java
index 742ac1f..84808a1 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/TransactionOp.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/api/transaction/TransactionOp.java
@@ -18,13 +18,39 @@
*/
package org.apache.curator.framework.api.transaction;
+import org.apache.curator.framework.CuratorFramework;
+
+/**
+ * Builds operations that can be committed as a transaction
+ * via {@link CuratorFramework#transaction()}
+ */
public interface TransactionOp
{
+ /**
+ * Start a create builder in the transaction
+ *
+ * @return builder object
+ */
TransactionCreateBuilder<CuratorOp> create();
+ /**
+ * Start a delete builder in the transaction
+ *
+ * @return builder object
+ */
TransactionDeleteBuilder<CuratorOp> delete();
+ /**
+ * Start a setData builder in the transaction
+ *
+ * @return builder object
+ */
TransactionSetDataBuilder<CuratorOp> setData();
+ /**
+ * Start a check builder in the transaction
+ *
+ * @return builder object
+ */
TransactionCheckBuilder<CuratorOp> check();
}