You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2015/06/26 21:16:09 UTC

incubator-tinkerpop git commit: Renamed Transaction.create() to createThreadedTx() TINKERPOP3-749

Repository: incubator-tinkerpop
Updated Branches:
  refs/heads/master d5b70bef8 -> 2c5474be0


Renamed Transaction.create() to createThreadedTx() TINKERPOP3-749


Project: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/commit/2c5474be
Tree: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/tree/2c5474be
Diff: http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/diff/2c5474be

Branch: refs/heads/master
Commit: 2c5474be0e6c79d665e8d68bf616db6c9cb1b435
Parents: d5b70be
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Fri Jun 26 15:15:25 2015 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Fri Jun 26 15:15:25 2015 -0400

----------------------------------------------------------------------
 CHANGELOG.asciidoc                                           | 1 +
 .../java/org/apache/tinkerpop/gremlin/structure/Graph.java   | 2 +-
 .../org/apache/tinkerpop/gremlin/structure/Transaction.java  | 8 ++++++--
 .../gremlin/structure/util/AbstractTransaction.java          | 4 ++--
 .../tinkerpop/gremlin/structure/FeatureSupportTest.java      | 2 +-
 .../apache/tinkerpop/gremlin/structure/TransactionTest.java  | 2 +-
 6 files changed, 12 insertions(+), 7 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/CHANGELOG.asciidoc
----------------------------------------------------------------------
diff --git a/CHANGELOG.asciidoc b/CHANGELOG.asciidoc
index c96ac2a..fafc641 100644
--- a/CHANGELOG.asciidoc
+++ b/CHANGELOG.asciidoc
@@ -26,6 +26,7 @@ TinkerPop 3.0.0.GA (NOT OFFICIALLY RELEASED YET)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 * `MatchStep` and `match()` no longer have a "start label" parameter -- it is computed if the incoming traverser does not have requisite labels.
+* Renamed `Transaction.create()` to `Transaction.createThreadedTx()`.
 * Added `TraversalParent.removeGlobalChild()` and `TraversalParent.removeLocalChild()`.
 * Add a `clear` option to the Gephi Plugin to empty the Gephi workspace.
 * `AbstractStep` now guarantees that bulk-less and null-valued traversers are never propagated.

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
index 7ef6d1b..c4a19a7 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Graph.java
@@ -414,7 +414,7 @@ public interface Graph extends AutoCloseable, Host {
 
             /**
              * Determines if the {@code Graph} implementation supports threaded transactions which allow a transaction
-             * to be executed across multiple threads via {@link org.apache.tinkerpop.gremlin.structure.Transaction#create()}.
+             * to be executed across multiple threads via {@link org.apache.tinkerpop.gremlin.structure.Transaction#createThreadedTx()}.
              */
             @FeatureDescriptor(name = FEATURE_THREADED_TRANSACTIONS)
             public default boolean supportsThreadedTransactions() {

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Transaction.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Transaction.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Transaction.java
index 6a1014e..e97a914 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Transaction.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/Transaction.java
@@ -62,9 +62,13 @@ public interface Transaction extends Closeable {
     public <R> Workload<R> submit(final Function<Graph, R> work);
 
     /**
-     * Creates a transaction that can be executed across multiple threads.
+     * Creates a transaction that can be executed across multiple threads. The {@link Graph} returned from this
+     * method is not meant to represent some form of child transaction that can be committed from this object.
+     * A threaded transaction is a {@link Graph} instance that has a transaction context that enables multiple
+     * threads to collaborate on the same transaction.  A standard transactional context tied to a {@link Graph}
+     * that supports transactions will typically bind a transaction to a single thread via {@link ThreadLocal}.
      */
-    public <G extends Graph> G create();
+    public <G extends Graph> G createThreadedTx();
 
     /**
      * Determines if a transaction is currently open.

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/AbstractTransaction.java
----------------------------------------------------------------------
diff --git a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/AbstractTransaction.java b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/AbstractTransaction.java
index 3b6c522..490dcc5 100644
--- a/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/AbstractTransaction.java
+++ b/gremlin-core/src/main/java/org/apache/tinkerpop/gremlin/structure/util/AbstractTransaction.java
@@ -31,7 +31,7 @@ import java.util.function.Function;
  * A simple base class for {@link Transaction} that provides some common functionality and default behavior.  Vendors
  * can use this class as a starting point for their own implementations. Implementers should note that this
  * class assumes that threaded transactions are not enabled.  Vendors should explicitly override
- * {@link #create} to implement that functionality if required.
+ * {@link #createThreadedTx} to implement that functionality if required.
  * <p/>
  * Note that transaction listeners are registered in a {@link ThreadLocal} fashion which matches the pattern
  * expected of vendor implementations of a {@link Transaction}.
@@ -117,7 +117,7 @@ public abstract class AbstractTransaction implements Transaction {
     }
 
     @Override
-    public <G extends Graph> G create() {
+    public <G extends Graph> G createThreadedTx() {
         throw Transaction.Exceptions.threadedTransactionsNotSupported();
     }
 

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/FeatureSupportTest.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/FeatureSupportTest.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/FeatureSupportTest.java
index c2106cb..1971b28 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/FeatureSupportTest.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/FeatureSupportTest.java
@@ -138,7 +138,7 @@ public class FeatureSupportTest {
         @FeatureRequirement(featureClass = Graph.Features.GraphFeatures.class, feature = FEATURE_THREADED_TRANSACTIONS, supported = false)
         public void shouldThrowOnThreadedTransactionNotSupported() {
             try {
-                graph.tx().create();
+                graph.tx().createThreadedTx();
                 fail("An exception should be thrown since the threaded transaction feature is not supported");
             } catch (Exception e) {
                 validateException(Transaction.Exceptions.threadedTransactionsNotSupported(), e);

http://git-wip-us.apache.org/repos/asf/incubator-tinkerpop/blob/2c5474be/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java
----------------------------------------------------------------------
diff --git a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java
index 7feb698..7d6c7c6 100644
--- a/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java
+++ b/gremlin-test/src/main/java/org/apache/tinkerpop/gremlin/structure/TransactionTest.java
@@ -559,7 +559,7 @@ public class TransactionTest extends AbstractGremlinTest {
         final int numberOfThreads = 10;
         final CountDownLatch latch = new CountDownLatch(numberOfThreads);
 
-        final Graph threadedG = g.tx().create();
+        final Graph threadedG = g.tx().createThreadedTx();
 
         for (int ix = 0; ix < numberOfThreads; ix++) {
             new Thread(() -> {