<!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 (version 1.7.0_75) on Fri May 13 13:32:17 PDT 2016 -->
<title>Sequence (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Sequence (Oracle - Berkeley DB Java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sequence.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/SequenceConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/Sequence.html" target="_top">Frames</a></li>
<li><a href="Sequence.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.db</div>
<h2 title="Class Sequence" class="title">Class Sequence</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.Sequence</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">Sequence</span>
extends java.lang.Object</pre>
<div class="block">A Sequence handle is used to manipulate a sequence record in a database.
Sequence handles are opened using the <a href="../../../com/sleepycat/db/Database.html#openSequence(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.SequenceConfig)"><code>Database.openSequence</code></a> method.</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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#close()">close</a></strong>()</code>
<div class="block">Close a sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#get(com.sleepycat.db.Transaction,%20int)">get</a></strong>(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
int delta)</code>
<div class="block">Return the next available element in the sequence and changes the sequence
value by <code>delta</code>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#getDatabase()">getDatabase</a></strong>()</code>
<div class="block">Return the Database handle associated with this sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#getKey()">getKey</a></strong>()</code>
<div class="block">Return the DatabaseEntry used to open this sequence.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../com/sleepycat/db/SequenceStats.html" title="class in com.sleepycat.db">SequenceStats</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#getStats(com.sleepycat.db.StatsConfig)">getStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code>
<div class="block">Return statistical information about the sequence.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/Sequence.html#printStats(com.sleepycat.db.StatsConfig)">printStats</a></strong>(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)</code>
<div class="block">Print statistical information about the sequence to a specified output
channel (see the setMsgfile() method for more information), or passed to an
application callback function (see the setMsgcall() method for more
information).</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 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="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Close a sequence. Any unused cached values are lost.
<p>
The sequence handle may not be used again after this method has been
called, regardless of the method's success or failure.
<p>
<p></div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl>
</li>
</ul>
<a name="get(com.sleepycat.db.Transaction, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public long get(<a href="../../../com/sleepycat/db/Transaction.html" title="class in com.sleepycat.db">Transaction</a> txn,
int delta)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return the next available element in the sequence and changes the sequence
value by <code>delta</code>. The value of <code>delta</code> must be
greater than zero. If there are enough cached values in the sequence
handle then they will be returned. Otherwise the next value will be
fetched from the database and incremented (decremented) by enough to cover
the <code>delta</code> and the next batch of cached values.
<p>
The <code>txn</code> handle must be null if the sequence handle was opened
with a non-zero cache size.
<p>
For maximum concurrency, a non-zero cache size should be specified prior to
opening the sequence handle, the <code>txn</code> handle should be
<code>null</code>, and <a href="../../../com/sleepycat/db/SequenceConfig.html#setAutoCommitNoSync(boolean)"><code>SequenceConfig.setAutoCommitNoSync</code></a> should
be called to disable log flushes.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>txn</code> - For a transactional database, an explicit transaction may be specified, or null
may be specified to use auto-commit. For a non-transactional database, null
must be specified.
<p></dd><dd><code>delta</code> - the amount by which to increment or decrement the sequence
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>the next available element in the sequence</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getDatabase()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabase</h4>
<pre>public <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db">Database</a> getDatabase()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return the Database handle associated with this sequence.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The Database handle associated with this sequence.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getKey()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKey</h4>
<pre>public <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> getKey()
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return the DatabaseEntry used to open this sequence.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The DatabaseEntry used to open this sequence.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="getStats(com.sleepycat.db.StatsConfig)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStats</h4>
<pre>public <a href="../../../com/sleepycat/db/SequenceStats.html" title="class in com.sleepycat.db">SequenceStats</a> getStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Return statistical information about the sequence.
<p>
In the presence of multiple threads or processes accessing an active
sequence, the information returned by this method may be out-of-date.
<p>
The getStats method cannot be transaction-protected. For this reason, it
should be called in a thread of control that has no open cursors or active
transactions.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics returned; if null, default statistics are returned.
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>Sequence statistics.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></dd></dl>
</li>
</ul>
<a name="printStats(com.sleepycat.db.StatsConfig)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>printStats</h4>
<pre>public int printStats(<a href="../../../com/sleepycat/db/StatsConfig.html" title="class in com.sleepycat.db">StatsConfig</a> config)
throws <a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
<div class="block">Print statistical information about the sequence to a specified output
channel (see the setMsgfile() method for more information), or passed to an
application callback function (see the setMsgcall() method for more
information).
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>config</code> - The statistics returned; if null, default statistics are returned.
<p></dd>
<dt><span class="strong">Returns:</span></dt><dd>A non-zero error value on failure and 0 on success.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code></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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/Sequence.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"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/SecondaryMultiKeyCreator.html" title="interface in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/SequenceConfig.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?com/sleepycat/db/Sequence.html" target="_top">Frames</a></li>
<li><a href="Sequence.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All 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>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </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, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
