Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

420 lines
17 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>CurrentTransaction (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="CurrentTransaction (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":9,"i5":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CurrentTransaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.collections</a></div>
<h2 title="Class CurrentTransaction" class="title">Class CurrentTransaction</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.collections.CurrentTransaction</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<pre>public class <span class="typeNameLabel">CurrentTransaction</span>
extends java.lang.Object</pre>
<div class="block">Provides access to the current transaction for the current thread within the
context of a Berkeley DB environment. This class provides explicit
transaction control beyond that provided by the <a href="TransactionRunner.html" title="class in com.sleepycat.collections"><code>TransactionRunner</code></a>
class. However, both methods of transaction control manage per-thread
transactions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#abortTransaction--">abortTransaction</a></span>()</code></th>
<td class="colLast">
<div class="block">Aborts the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#beginTransaction-com.sleepycat.db.TransactionConfig-">beginTransaction</a></span>&#8203;(<a href="../db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a>&nbsp;config)</code></th>
<td class="colLast">
<div class="block">Begins a new transaction for this environment and associates it with
the current thread.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#commitTransaction--">commitTransaction</a></span>()</code></th>
<td class="colLast">
<div class="block">Commits the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../db/Environment.html" title="class in com.sleepycat.db">Environment</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEnvironment--">getEnvironment</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the underlying Berkeley DB environment.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>static <a href="CurrentTransaction.html" title="class in com.sleepycat.collections">CurrentTransaction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getInstance-com.sleepycat.db.Environment-">getInstance</a></span>&#8203;(<a href="../db/Environment.html" title="class in com.sleepycat.db">Environment</a>&nbsp;env)</code></th>
<td class="colLast">
<div class="block">Gets the CurrentTransaction accessor for a specified Berkeley DB
environment.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransaction--">getTransaction</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the transaction associated with the current thread for this
environment, or null if no transaction is active.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getInstance-com.sleepycat.db.Environment-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getInstance</h4>
<pre class="methodSignature">public static&nbsp;<a href="CurrentTransaction.html" title="class in com.sleepycat.collections">CurrentTransaction</a>&nbsp;getInstance&#8203;(<a href="../db/Environment.html" title="class in com.sleepycat.db">Environment</a>&nbsp;env)</pre>
<div class="block">Gets the CurrentTransaction accessor for a specified Berkeley DB
environment. This method always returns the same reference when called
more than once with the same environment parameter.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>env</code> - is an open Berkeley DB environment.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the CurrentTransaction accessor for the given environment, or
null if the environment is not transactional.</dd>
</dl>
</li>
</ul>
<a name="getEnvironment--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnvironment</h4>
<pre class="methodSignature">public final&nbsp;<a href="../db/Environment.html" title="class in com.sleepycat.db">Environment</a>&nbsp;getEnvironment()</pre>
<div class="block">Returns the underlying Berkeley DB environment.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Environment.</dd>
</dl>
</li>
</ul>
<a name="getTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransaction</h4>
<pre class="methodSignature">public final&nbsp;<a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a>&nbsp;getTransaction()</pre>
<div class="block">Returns the transaction associated with the current thread for this
environment, or null if no transaction is active.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Transaction.</dd>
</dl>
</li>
</ul>
<a name="beginTransaction-com.sleepycat.db.TransactionConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>beginTransaction</h4>
<pre class="methodSignature">public final&nbsp;<a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a>&nbsp;beginTransaction&#8203;(<a href="../db/TransactionConfig.html" title="class in com.sleepycat.db">TransactionConfig</a>&nbsp;config)
throws <a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Begins a new transaction for this environment and associates it with
the current thread. If a transaction is already active for this
environment and thread, a nested transaction will be created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>config</code> - the transaction configuration used for calling
<a href="../db/Environment.html#beginTransaction-com.sleepycat.db.Transaction-com.sleepycat.db.TransactionConfig-"><code>Environment.beginTransaction(com.sleepycat.db.Transaction, com.sleepycat.db.TransactionConfig)</code></a>, or null to use the default
configuration.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the new transaction.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if the transaction cannot be started, in which
case any existing transaction is not affected.</dd>
<dd><code>java.lang.IllegalStateException</code> - if a transaction is already active and
nested transactions are not supported by the environment.</dd>
</dl>
</li>
</ul>
<a name="commitTransaction--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>commitTransaction</h4>
<pre class="methodSignature">public final&nbsp;<a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a>&nbsp;commitTransaction()
throws <a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
java.lang.IllegalStateException</pre>
<div class="block">Commits the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parent transaction or null if the committed transaction was
not nested.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if an error occurs committing the transaction.
The transaction will still be closed and the parent transaction will
become the current transaction.</dd>
<dd><code>java.lang.IllegalStateException</code> - if no transaction is active for the
current thread for this environment.</dd>
</dl>
</li>
</ul>
<a name="abortTransaction--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>abortTransaction</h4>
<pre class="methodSignature">public final&nbsp;<a href="../db/Transaction.html" title="class in com.sleepycat.db">Transaction</a>&nbsp;abortTransaction()
throws <a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a>,
java.lang.IllegalStateException</pre>
<div class="block">Aborts the transaction that is active for the current thread for this
environment and makes the parent transaction (if any) the current
transaction.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the parent transaction or null if the aborted transaction was
not nested.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if an error occurs aborting the transaction.
The transaction will still be closed and the parent transaction will
become the current transaction.</dd>
<dd><code>java.lang.IllegalStateException</code> - if no transaction is active for the
current thread for this environment.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CurrentTransaction.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>