src/jdk.incubator.adba/share/classes/jdk/incubator/sql2/TransactionCompletion.java
branchJDK-8188051-branch
changeset 56828 64304e37e9b1
child 56997 c9cbac2979fb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/jdk.incubator.adba/share/classes/jdk/incubator/sql2/TransactionCompletion.java	Wed Jul 11 19:36:23 2018 -0400
@@ -0,0 +1,75 @@
+/*
+ * Copyright (c)  2017, 2018, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+package jdk.incubator.sql2;
+
+/**
+ * A mutable object that controls whether a transactionCompletion Operation sends
+ * a database commit or a database rollback to the server. A transactionCompletion
+ * Operation is created with a TransactionCompletion. By default a transactionCompletion
+ * Operation requests that the database end the transaction with a commit.
+ * If {@link TransactionCompletion#setRollbackOnly} is called on the TransactionCompletion used to create
+ the Operation prior to the Operation being executed, the Operation will
+ request that the database end the transaction with a rollback.
+ 
+ Example:
+
+ <pre>
+ * {@code
+   TransactionCompletion t = session.transactionCompletion();
+   session.countOperation(updateSql)
+       .resultProcessor( count -> { if (count > 1) t.setRollbackOnly(); } )
+       .submit();
+   session.commitMaybeRollback(t);
+ }</pre>
+
+ A TransactionCompletion can not be used to create more than one endTransaction 
+ Operation.
+ 
+ A TransactionCompletion is thread safe.
+ 
+ ISSUE: The name is terrible. Please suggest a better alternative, TransactionLatch?
+ */
+public interface TransactionCompletion {
+
+  /**
+   * Causes an endTransactionOperation created with this TransactionCompletion that is executed
+   * subsequent to this call to perform a rollback. If this method is not called
+   * prior to Operation execution the Operation will perform a commit.
+   *
+   * @return true if the call succeeded. False if the call did not succeed in
+ setting the TransactionCompletion rollback only because the endTransaction
+ Operation had already been executed.
+   */
+  public boolean setRollbackOnly();
+
+  /**
+   * Returns {@code true} iff the {@link setRollbackOnly} method has been called
+ on this TransactionCompletion
+   *
+   * @return {@code true} if {@link setRollbackOnly} has been called.
+   */
+  public boolean isRollbackOnly();
+
+}