mirror of
https://github.com/yasuhirokimura/db18
synced 2026-06-08 18:29:23 +00:00
Yasuhiro KIMURA
1900 lines
105 KiB
HTML
1900 lines
105 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>Cursor (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="Cursor (Oracle - Berkeley DB Java API)";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10,"i30":10,"i31":10,"i32":10};
|
|
var tabs = {65535:["t0","All 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/Cursor.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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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"> </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> <a href="package-summary.html">com.sleepycat.db</a></div>
|
|
<h2 title="Class Cursor" class="title">Class Cursor</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li>java.lang.Object</li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>com.sleepycat.db.Cursor</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><code><a href="SecondaryCursor.html" title="class in com.sleepycat.db">SecondaryCursor</a></code></dd>
|
|
</dl>
|
|
<hr>
|
|
<pre>public class <span class="typeNameLabel">Cursor</span>
|
|
extends java.lang.Object</pre>
|
|
<div class="block">A database cursor. Cursors are used for operating on collections of
|
|
records, for iterating over a database, and for saving handles to
|
|
individual records, so that they can be modified after they have been
|
|
read.
|
|
<p>
|
|
Cursors may be used by multiple threads, but only serially. That is,
|
|
the application must serialize access to the handle.
|
|
<p>
|
|
If the cursor is to be used to perform operations on behalf of a
|
|
transaction, the cursor must be opened and closed within the context of
|
|
that single transaction.
|
|
<p>
|
|
If you do not close the cursor before closing the database handle or the
|
|
transaction handle that owns this cursor, then, closing a database
|
|
handle or a transaction handle closes these open cursors.
|
|
Once the cursor close method has been called, the handle may not be
|
|
accessed again, regardless of the close method's success or failure.
|
|
<p>
|
|
To obtain a cursor with default attributes:
|
|
<blockquote><pre>
|
|
Cursor cursor = myDatabase.openCursor(txn, null);
|
|
</pre></blockquote>
|
|
To customize the attributes of a cursor, use a CursorConfig object.
|
|
<blockquote><pre>
|
|
CursorConfig config = new CursorConfig();
|
|
config.setDirtyRead(true);
|
|
Cursor cursor = myDatabase.openCursor(txn, config);
|
|
</pre></blockquote>
|
|
<p>
|
|
Modifications to the database during a sequential scan will be reflected
|
|
in the scan; that is, records inserted behind a cursor will not be
|
|
returned while records inserted in front of a cursor will be returned.
|
|
In Queue and Recno databases, missing entries (that is, entries that
|
|
were never explicitly created or that were created and then deleted)
|
|
will be ignored during a sequential scan.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier</th>
|
|
<th class="colSecond" scope="col">Constructor</th>
|
|
<th class="colLast" scope="col">Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected </code></td>
|
|
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#Cursor-com.sleepycat.db.Database-com.sleepycat.db.CursorConfig-">Cursor</a></span>​(<a href="Database.html" title="class in com.sleepycat.db">Database</a> database,
|
|
<a href="CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</code></th>
|
|
<td class="colLast"> </td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#close--">close</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Discard the cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#compare-com.sleepycat.db.Cursor-">compare</a></span>​(<a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a> OtherCursor)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a comparison of the two cursors.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code>int</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#count--">count</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a count of the number of data items for the key to which the
|
|
cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#delete--">delete</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Delete the key/data pair to which the cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#dup-boolean-">dup</a></span>​(boolean samePosition)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Creates a new cursor that uses the same transaction and locker ID as the
|
|
original cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getConfig--">getConfig</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return this cursor's configuration.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getCurrent-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getCurrent</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Returns the key/data pair to which the cursor refers.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="Database.html" title="class in com.sleepycat.db">Database</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDatabase--">getDatabase</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the Database handle associated with this Cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getFirst</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getLast</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i10" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNext-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNext</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i11" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair
|
|
of the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i12" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getNextNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getNextNoDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i13" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrev-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrev</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i14" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrevDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i15" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPrevNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getPrevNoDup</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i16" class="altColor">
|
|
<td class="colFirst"><code><a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPriority--">getPriority</a></span>()</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Get the cache priority for pages referenced by the cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i17" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getRecordNumber</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return the record number associated with the cursor.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i18" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchBoth-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBoth</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specified key/data pair, where both the key and
|
|
data items must match.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i19" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchBothRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchBothRange</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specified key and matching data item of the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i20" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchKey-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKey</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i21" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchKeyRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchKeyRange</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i22" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSearchRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">getSearchRecordNumber</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Move the cursor to the specific numbered record of the database, and
|
|
return the associated key/data pair.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i23" class="rowColor">
|
|
<td class="colFirst"><code><a href="DatabaseStream.html" title="class in com.sleepycat.db">DatabaseStream</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#openDatabaseStream-com.sleepycat.db.DatabaseStreamConfig-">openDatabaseStream</a></span>​(<a href="DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a> config)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Return a database stream pointing to a key/data pair where the data item
|
|
is an external file.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i24" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#put-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">put</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i25" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putAfter-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putAfter</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i26" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putBefore-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putBefore</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i27" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putCurrent-com.sleepycat.db.DatabaseEntry-">putCurrent</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Replaces the data in the key/data pair at the current cursor position.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i28" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putKeyFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putKeyFirst</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i29" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putKeyLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putKeyLast</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i30" class="altColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putNoDupData-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putNoDupData</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i31" class="rowColor">
|
|
<td class="colFirst"><code><a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a></code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putNoOverwrite-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">putNoOverwrite</a></span>​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Store a key/data pair into the database.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i32" class="altColor">
|
|
<td class="colFirst"><code>void</code></td>
|
|
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setPriority-com.sleepycat.db.CacheFilePriority-">setPriority</a></span>​(<a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> priority)</code></th>
|
|
<td class="colLast">
|
|
<div class="block">Set the cache priority for pages referenced by the DBC handle.</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">
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="Cursor-com.sleepycat.db.Database-com.sleepycat.db.CursorConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>Cursor</h4>
|
|
<pre>protected Cursor​(<a href="Database.html" title="class in com.sleepycat.db">Database</a> database,
|
|
<a href="CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> config)</pre>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ 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 class="methodSignature">public void close()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Discard the cursor.
|
|
<p>
|
|
After the close method has been called, you cannot use the cursor handle
|
|
again.
|
|
<p>
|
|
It is not required to close the cursor explicitly before closing the
|
|
database handle or the transaction handle that owns this cursor because
|
|
closing a database handle or transaction handle closes those open cursor.
|
|
<p>
|
|
However, it is recommended that you always close all cursor handles
|
|
immediately after their use to promote concurrency and to release resources
|
|
such as page locks.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock. If the application is already intending to abort the transaction,
|
|
this exception should be ignored, and the application should proceed.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="dup-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>dup</h4>
|
|
<pre class="methodSignature">public <a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a> dup​(boolean samePosition)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Creates a new cursor that uses the same transaction and locker ID as the
|
|
original cursor.
|
|
<p>
|
|
This is useful when an application is using locking and requires two
|
|
or more cursors in the same thread of control.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>samePosition</code> - If true, the newly created cursor is initialized to refer to the
|
|
same position in the database as the original cursor (if any) and
|
|
hold the same locks (if any). If false, or the original cursor does
|
|
not hold a database position and locks, the returned cursor is
|
|
uninitialized and will behave like a newly created cursor.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A new cursor with the same transaction and locker ID as the original
|
|
cursor.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getConfig--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getConfig</h4>
|
|
<pre class="methodSignature">public <a href="CursorConfig.html" title="class in com.sleepycat.db">CursorConfig</a> getConfig()</pre>
|
|
<div class="block">Return this cursor's configuration.
|
|
<p>
|
|
This may differ from the configuration used to open this object if
|
|
the cursor existed previously.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>This cursor's configuration.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getDatabase--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getDatabase</h4>
|
|
<pre class="methodSignature">public <a href="Database.html" title="class in com.sleepycat.db">Database</a> getDatabase()</pre>
|
|
<div class="block">Return the Database handle associated with this Cursor.
|
|
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>The Database handle associated with this Cursor.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="compare-com.sleepycat.db.Cursor-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>compare</h4>
|
|
<pre class="methodSignature">public int compare​(<a href="Cursor.html" title="class in com.sleepycat.db">Cursor</a> OtherCursor)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a comparison of the two cursors. Two cursors are
|
|
equal if and only if they are positioned
|
|
on the same item in the same database.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>OtherCursor</code> - the other cursor to be compared</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>An integer representing the result of the
|
|
comparison between this cursor and OtherCursor (another
|
|
cursor handle used as the comparator). 0 indicates that this cursor and
|
|
OtherCursor are positioned on the same item, 1
|
|
indicates this cursor is greater than OtherCursor, -1 indicates that
|
|
OtherCursor is greater than this cursor.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="count--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>count</h4>
|
|
<pre class="methodSignature">public int count()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a count of the number of data items for the key to which the
|
|
cursor refers.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A count of the number of data items for the key to which the cursor
|
|
refers.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="delete--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>delete</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> delete()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Delete the key/data pair to which the cursor refers.
|
|
<p>
|
|
When called on a cursor opened on a database that has been made into a
|
|
secondary index, this method deletes the key/data pair from the primary database
|
|
and all secondary indices.
|
|
<p>
|
|
The cursor position is unchanged after a delete, and subsequent calls
|
|
to cursor functions expecting the cursor to refer to an existing key
|
|
will fail.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor
|
|
position has been deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getCurrent-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getCurrent</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getCurrent​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Returns the key/data pair to which the cursor refers.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the key/pair at the cursor
|
|
position has been deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getFirst</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getFirst​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the first key/data pair of the database, and return
|
|
that pair. If the first key has duplicate values, the first data item
|
|
in the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getLast</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getLast​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the last key/data pair of the database, and return
|
|
that pair. If the last key has duplicate values, the last data item in
|
|
the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNext-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNext</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNext​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the next key/data pair and return that pair. If
|
|
the matching key has duplicate values, the first data item in the set
|
|
of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next key/data pair of the database, and that pair
|
|
is returned. In the presence of duplicate key values, the value of the
|
|
key may not change.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">If the next key/data pair of the database is a duplicate data record for
|
|
the current key/data pair, move the cursor to the next key/data pair
|
|
of the database and return that pair.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getNextNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getNextNoDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getNextNoDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the next non-duplicate key/data pair and return
|
|
that pair. If the matching key has duplicate values, the first data
|
|
item in the set of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the first
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the next non-duplicate key of the database, and that
|
|
key/data pair is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrev-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrev</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrev​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the previous key/data pair and return that pair.
|
|
If the matching key has duplicate values, the last data item in the set
|
|
of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous key/data pair of the database, and that
|
|
pair is returned. In the presence of duplicate key values, the value of
|
|
the key may not change.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">If the previous key/data pair of the database is a duplicate data record
|
|
for the current key/data pair, move the cursor to the previous key/data
|
|
pair of the database and return that pair.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPrevNoDup-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPrevNoDup</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getPrevNoDup​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the previous non-duplicate key/data pair and return
|
|
that pair. If the matching key has duplicate values, the last data item
|
|
in the set of duplicates is returned.
|
|
<p>
|
|
If the cursor is not yet initialized, move the cursor to the last
|
|
key/data pair of the database, and return that pair. Otherwise, the
|
|
cursor is moved to the previous non-duplicate key of the database, and
|
|
that key/data pair is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getRecordNumber</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getRecordNumber​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return the record number associated with the cursor. The record number
|
|
will be returned in the data parameter.
|
|
<p>
|
|
For this method to be called, the underlying database must be of type
|
|
Btree, and it must have been configured to support record numbers.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKey-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKey</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKey​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the given key of the database, and return the datum
|
|
associated with the given key. If the matching key has duplicate
|
|
values, the first data item in the set of duplicates is returned.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchKeyRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchKeyRange</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchKeyRange​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the closest matching key of the database, and return
|
|
the data item associated with the matching key. If the matching key has
|
|
duplicate values, the first data item in the set of duplicates is returned.
|
|
<p>
|
|
The returned key/data pair is for the smallest key greater than or equal
|
|
to the specified key (as determined by the key comparison function),
|
|
permitting partial key matches and range searches.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBoth-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBoth</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBoth​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specified key/data pair, where both the key and
|
|
data items must match.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
used as input. It must be initialized with a non-null byte array by the
|
|
caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchBothRange-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchBothRange</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchBothRange​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specified key and matching data item of the database.
|
|
<p>
|
|
In the case of any database supporting sorted duplicate sets, the returned
|
|
key/data pair is for the smallest data item greater than or equal to the
|
|
specified data item (as determined by the duplicate comparison function),
|
|
permitting partial matches and range searches in duplicate data sets.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
used as input and returned as output. It must be initialized with a non-null
|
|
byte array by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getSearchRecordNumber-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.LockMode-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getSearchRecordNumber</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> getSearchRecordNumber​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data,
|
|
<a href="LockMode.html" title="class in com.sleepycat.db">LockMode</a> lockMode)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Move the cursor to the specific numbered record of the database, and
|
|
return the associated key/data pair.
|
|
<p>
|
|
The data field of the specified key must be a byte array containing a
|
|
record number, as described in <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a>. This determines
|
|
the record to be retrieved.
|
|
<p>
|
|
For this method to be called, the underlying database must be of type
|
|
Btree, and it must have been configured to support record numbers.
|
|
<p>
|
|
If this method fails for any reason, the position of the cursor will be
|
|
unchanged.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key
|
|
returned as output. Its byte array does not need to be initialized by the
|
|
caller.</dd>
|
|
<dd><code>data</code> - the data
|
|
returned as output. Multiple results can be retrieved by passing an object
|
|
that is a subclass of <a href="MultipleEntry.html" title="class in com.sleepycat.db"><code>MultipleEntry</code></a>, otherwise its byte array does not
|
|
need to be initialized by the caller.</dd>
|
|
<dd><code>lockMode</code> - the locking attributes; if null, default attributes are used.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a> if no matching key/data pair is
|
|
found; <a href="OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a> if the database is a Queue or Recno database and the specified key exists, but was never explicitly created by the application or was later deleted; otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code>java.lang.NullPointerException</code> - if a DatabaseEntry parameter is null or
|
|
does not contain a required non-null byte array.
|
|
<p></dd>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.
|
|
<p></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="put-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>put</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> put​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the put method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the put method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
If the key already appears in the database and duplicates are supported,
|
|
the new data value is inserted at the correct sorted location. If the
|
|
key already appears in the database and duplicates are not supported,
|
|
the existing key/data pair will be replaced.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putAfter-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putAfter</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putAfter​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putAfter method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putAfter method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
In the case of the Btree and Hash access methods, insert the data
|
|
element as a duplicate element of the key to which the cursor refers.
|
|
The new element appears immediately
|
|
after
|
|
the current cursor position. It is an error to call this method if the
|
|
underlying Btree or Hash database does not support duplicate data items.
|
|
The key parameter is ignored.
|
|
<p>
|
|
In the case of the Hash access method, the putAfter method will fail and
|
|
throw an exception if the current cursor record has already been deleted.
|
|
<p>
|
|
In the case of the Recno access method, it is an error to call this
|
|
method if the underlying Recno database was not configured to have
|
|
mutable record numbers. A new key is created, all records after the
|
|
inserted item are automatically renumbered, and the key of the new
|
|
record is returned in the key parameter. The initial value of the key
|
|
parameter is ignored.
|
|
<p>
|
|
The putAfter method may not be called for the Queue access method.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a>
|
|
if the current cursor record has already been deleted and the underlying access method is Hash;
|
|
otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putBefore-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putBefore</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putBefore​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putBefore method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putBefore method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
In the case of the Btree and Hash access methods, insert the data
|
|
element as a duplicate element of the key to which the cursor refers.
|
|
The new element appears immediately
|
|
before
|
|
the current cursor position. It is an error to call this method if the
|
|
underlying Btree or Hash database does not support duplicate data items.
|
|
The key parameter is ignored.
|
|
<p>
|
|
In the case of the Hash access method, the putBefore method will fail and
|
|
throw an exception if the current cursor record has already been deleted.
|
|
<p>
|
|
In the case of the Recno access method, it is an error to call this
|
|
method if the underlying Recno database was not configured to have
|
|
mutable record numbers. A new key is created, all records after the
|
|
inserted item are automatically renumbered, and the key of the new
|
|
record is returned in the key parameter. The initial value of the key
|
|
parameter is ignored.
|
|
<p>
|
|
The putBefore method may not be called for the Queue access method.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a>
|
|
if the current cursor record has already been deleted and the underlying access method is Hash;
|
|
otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putNoOverwrite-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putNoOverwrite</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putNoOverwrite​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putNoOverwrite method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putNoOverwrite method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
If the key already appears in the database, putNoOverwrite will return
|
|
<a href="OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a>.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a>
|
|
if a matching key/data pair already exists in the database;
|
|
otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putKeyFirst-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putKeyFirst</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putKeyFirst​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putKeyFirst method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putKeyFirst method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
In the case of the Btree and Hash access methods, insert the specified
|
|
key/data pair into the database.
|
|
<p>
|
|
If the underlying database supports duplicate data items, and if the
|
|
key already exists in the database and a duplicate sort function has
|
|
been specified, the inserted data item is added in its sorted location.
|
|
If the key already exists in the database and no duplicate sort function
|
|
has been specified, the inserted data item is added as the
|
|
first
|
|
of the data items for that key.
|
|
<p>
|
|
The putKeyFirst method may not be called for the Queue or Recno access methods.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putKeyLast-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putKeyLast</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putKeyLast​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putKeyLast method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putKeyLast method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
In the case of the Btree and Hash access methods, insert the specified
|
|
key/data pair into the database.
|
|
<p>
|
|
If the underlying database supports duplicate data items, and if the
|
|
key already exists in the database and a duplicate sort function has
|
|
been specified, the inserted data item is added in its sorted location.
|
|
If the key already exists in the database and no duplicate sort function
|
|
has been specified, the inserted data item is added as the
|
|
last
|
|
of the data items for that key.
|
|
<p>
|
|
The putKeyLast method may not be called for the Queue or Recno access methods.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putNoDupData-com.sleepycat.db.DatabaseEntry-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putNoDupData</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putNoDupData​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> key,
|
|
<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Store a key/data pair into the database.
|
|
<p>
|
|
If the putNoDupData method succeeds, the cursor is always positioned to refer to
|
|
the newly inserted item. If the putNoDupData method fails for any reason, the
|
|
state of the cursor will be unchanged.
|
|
<p>
|
|
In the case of the Btree and Hash access methods, insert
|
|
the specified key/data pair into the database, unless a key/data pair
|
|
comparing equally to it already exists in the database. If a matching
|
|
key/data pair already exists in the database, <a href="OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a> is returned.
|
|
<p>
|
|
This method may only be called if the underlying database has been
|
|
configured to support sorted duplicate data items.
|
|
<p>
|
|
This method may not be called for the Queue or Recno access methods.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>key</code> - the key <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> operated on.
|
|
<p></dd>
|
|
<dd><code>data</code> - the data <a href="DatabaseEntry.html" title="class in com.sleepycat.db"><code>DatabaseEntry</code></a> stored.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#KEYEXIST"><code>OperationStatus.KEYEXIST</code></a>
|
|
if a matching key/data pair already exists in the database;
|
|
otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - if the operation was selected to resolve a
|
|
deadlock.
|
|
<p></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - if an invalid parameter was specified.
|
|
<p></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="putCurrent-com.sleepycat.db.DatabaseEntry-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>putCurrent</h4>
|
|
<pre class="methodSignature">public <a href="OperationStatus.html" title="class in com.sleepycat.db">OperationStatus</a> putCurrent​(<a href="DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> data)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Replaces the data in the key/data pair at the current cursor position.
|
|
<p>
|
|
Whether the putCurrent method succeeds or fails for any reason, the state
|
|
of the cursor will be unchanged.
|
|
<p>
|
|
Overwrite the data of the key/data pair to which the cursor refers with the
|
|
specified data item. This method will return OperationStatus.NOTFOUND if
|
|
the cursor currently refers to an already-deleted key/data pair.
|
|
<p>
|
|
For a database that does not support duplicates, the data may be changed by
|
|
this method. If duplicates are supported, the data may be changed only if
|
|
a custom partial comparator is configured and the comparator considers the
|
|
old and new data to be equal (that is, the comparator returns zero). For
|
|
more information on partial comparators see <a href="DatabaseConfig.html#setDuplicateComparator-java.util.Comparator-"><code>DatabaseConfig.setDuplicateComparator(java.util.Comparator)</code></a>.
|
|
<p>
|
|
If the old and new data are unequal according to the comparator, a <code>
|
|
DatabaseException</code> is thrown. Changing the data in this case would change
|
|
the sort order of the record, which would change the cursor position, and
|
|
this is not allowed. To change the sort order of a record, delete it and
|
|
then re-insert it.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>data</code> - the data DatabaseEntry stored.
|
|
<br></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd><a href="OperationStatus.html#NOTFOUND"><code>OperationStatus.NOTFOUND</code></a>
|
|
if the current cursor record has already been deleted;
|
|
otherwise, <a href="OperationStatus.html#SUCCESS"><code>OperationStatus.SUCCESS</code></a>.
|
|
<br></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DeadlockException.html" title="class in com.sleepycat.db">DeadlockException</a></code> - - if the operation was selected to resolve a
|
|
deadlock.
|
|
<br></dd>
|
|
<dd><code>java.lang.IllegalArgumentException</code> - - if an invalid parameter was specified.
|
|
<br></dd>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - - if the old and new data are not equal according
|
|
to the configured duplicate comparator or default comparator, or if a
|
|
failure occurs.
|
|
<br></dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="getPriority--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>getPriority</h4>
|
|
<pre class="methodSignature">public <a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> getPriority()
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Get the cache priority for pages referenced by the cursor.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>the cache priority for pages referenced by the cursor</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="setPriority-com.sleepycat.db.CacheFilePriority-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>setPriority</h4>
|
|
<pre class="methodSignature">public void setPriority​(<a href="CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> priority)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Set the cache priority for pages referenced by the DBC handle.
|
|
<p>
|
|
The priority of a page biases the replacement algorithm to be more or less
|
|
likely to discard a page when space is needed in the buffer pool. The bias
|
|
is temporary, and pages will eventually be discarded if they are not
|
|
referenced again. The setPriority method is only advisory, and
|
|
does not guarantee pages will be treated in a specific way.
|
|
<p>
|
|
This method may be called at any time during the life of the application.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>priority</code> - the new cache priority</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="openDatabaseStream-com.sleepycat.db.DatabaseStreamConfig-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>openDatabaseStream</h4>
|
|
<pre class="methodSignature">public <a href="DatabaseStream.html" title="class in com.sleepycat.db">DatabaseStream</a> openDatabaseStream​(<a href="DatabaseStreamConfig.html" title="class in com.sleepycat.db">DatabaseStreamConfig</a> config)
|
|
throws <a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></pre>
|
|
<div class="block">Return a database stream pointing to a key/data pair where the data item
|
|
is an external file.
|
|
<p></div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>config</code> - The database stream attributes. If null, default attributes are used.
|
|
<p></dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>A database stream.
|
|
<p></dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if the data item is not an external file.</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/Cursor.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 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: </li>
|
|
<li>Nested | </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li>Field | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </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>
|