diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/DatabaseEntry.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/DatabaseEntry.html | 1846 |
1 files changed, 882 insertions, 964 deletions
diff --git a/docs/java/com/sleepycat/db/DatabaseEntry.html b/docs/java/com/sleepycat/db/DatabaseEntry.html index 3cc52800..4e9e6670 100644 --- a/docs/java/com/sleepycat/db/DatabaseEntry.html +++ b/docs/java/com/sleepycat/db/DatabaseEntry.html @@ -1,112 +1,111 @@ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> -<!--NewPage--> -<HTML> -<HEAD> -<!-- Generated by javadoc (build 1.6.0_23) on Fri May 11 14:10:04 EDT 2012 --> -<TITLE> -DatabaseEntry (Oracle - Berkeley DB Java API) -</TITLE> - -<META NAME="date" CONTENT="2012-05-11"> - -<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> - -<SCRIPT type="text/javascript"> -function windowTitle() -{ +<!-- NewPage --> +<html lang="en"> +<head> +<!-- Generated by javadoc (version 1.7.0_60) on Tue Feb 17 12:25:53 EST 2015 --> +<title>DatabaseEntry (Oracle - Berkeley DB Java API)</title> +<meta name="date" content="2015-02-17"> +<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style"> +</head> +<body> +<script type="text/javascript"><!-- if (location.href.indexOf('is-external=true') == -1) { parent.document.title="DatabaseEntry (Oracle - Berkeley DB Java API)"; } -} -</SCRIPT> -<NOSCRIPT> -</NOSCRIPT> - -</HEAD> - -<BODY BGCOLOR="white" onload="windowTitle();"> -<HR> - - +//--> +</script> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> <!-- ========= START OF TOP NAVBAR ======= --> -<A NAME="navbar_top"><!-- --></A> -<A HREF="#skip-navbar_top" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_top_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/DatabaseEntry.html" target="_top"><B>FRAMES</B></A> - <A HREF="DatabaseEntry.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="topNav"><a name="navbar_top"> +<!-- --> +</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DatabaseEntry.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/DatabaseEntry.html" target="_top">Frames</a></li> +<li><a href="DatabaseEntry.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_top"></A> +</script> +</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 ========= --> - -<HR> <!-- ======== START OF CLASS DATA ======== --> -<H2> -<FONT SIZE="-1"> -com.sleepycat.db</FONT> -<BR> -Class DatabaseEntry</H2> -<PRE> -<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> - <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.DatabaseEntry</B> -</PRE> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db">MultipleEntry</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>DatabaseEntry</B><DT>extends <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></DL> -</PRE> - -<P> -Encodes database key and data items as a byte array. +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class DatabaseEntry" class="title">Class DatabaseEntry</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.DatabaseEntry</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/sleepycat/db/MultipleEntry.html" title="class in com.sleepycat.db">MultipleEntry</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DatabaseEntry</span> +extends java.lang.Object</pre> +<div class="block">Encodes database key and data items as a byte array. <p> -Storage and retrieval for the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> and <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> methods +Storage and retrieval for the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> and <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> methods are based on key/data pairs. Both key and data items are represented by DatabaseEntry objects. Key and data byte arrays may refer to arrays of zero length up to arrays of essentially unlimited length. @@ -118,10 +117,10 @@ references to other structures. <p> Access to DatabaseEntry objects is not re-entrant. In particular, if multiple threads simultaneously access the same DatabaseEntry object using -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> or <A HREF="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><CODE>Cursor</CODE></A> methods, the results are undefined. +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> or <a href="../../../com/sleepycat/db/Cursor.html" title="class in com.sleepycat.db"><code>Cursor</code></a> methods, the results are undefined. <p> DatabaseEntry objects may be used in conjunction with the object mapping -support provided in the <A HREF="../../../com/sleepycat/bind/package-summary.html"><CODE>com.sleepycat.bind</CODE></A> package. +support provided in the <a href="../../../com/sleepycat/bind/package-summary.html"><code>com.sleepycat.bind</code></a> package. <p> <h3>Input and Output Parameters</h3> <p> @@ -129,7 +128,7 @@ DatabaseEntry objects are used for both input data (when writing to a database or specifying a search parameter) and output data (when reading from a database). For certain methods, one parameter may be an input parameter and another may be an output parameter. For example, the -<A HREF="../../../com/sleepycat/db/Database.html#get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)"><CODE>Database.get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)</CODE></A> method has an input key parameter and an output +<a href="../../../com/sleepycat/db/Database.html#get(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.LockMode)"><code>Database.get(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.LockMode)</code></a> method has an input key parameter and an output data parameter. The documentation for each method describes whether its parameters are input or output parameters. <p> @@ -139,15 +138,15 @@ output parameters, the method called will initialize the data array. <p> For DatabaseEntry output parameters, by default the method called will reuse the byte array in the DatabaseEntry, if the data returned fits in -the byte array. This behavior can be configured with <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setReuseBuffer(boolean)"><CODE>setReuseBuffer(boolean)</CODE></A> or <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int, boolean)"><CODE>setUserBuffer(int, boolean)</CODE></A>. If an entry is configured to +the byte array. This behavior can be configured with <a href="../../../com/sleepycat/db/DatabaseEntry.html#setReuseBuffer(boolean)"><code>setReuseBuffer(boolean)</code></a> or <a href="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int,%20boolean)"><code>setUserBuffer(int, boolean)</code></a>. If an entry is configured to reuse the byte array (the default behavior), the length of the underlying byte array should not be used to determine the amount of data returned each -time the entry is used as an output parameter, rather the <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getSize()"><CODE>getSize()</CODE></A> +time the entry is used as an output parameter, rather the <a href="../../../com/sleepycat/db/DatabaseEntry.html#getSize()"><code>getSize()</code></a> call should be used. If an entry is configured to not reuse the byte array, a new array is allocated each time the entry is used as an output parameter, so the application can safely keep a reference to the byte array returned -by <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getData()"><CODE>getData()</CODE></A> without danger that the array will be overwritten in +by <a href="../../../com/sleepycat/db/DatabaseEntry.html#getData()"><code>getData()</code></a> without danger that the array will be overwritten in a subsequent call. <p> <h3>Offset and Size Properties</h3> @@ -181,662 +180,608 @@ By default the specified data (byte array, offset and size) corresponds to the full stored key or data item. Optionally, the Partial property can be set to true, and the PartialOffset and PartialLength properties are used to specify the portion of the key or data item to be read or written. For -details, see the <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A> method. +details, see the <a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a> method. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method, nor will they every be set by bindings. Therefore, the application can assume that the Partial properties -are not set, unless the application itself sets them explicitly. -<P> - -<P> -<HR> - -<P> - +are not set, unless the application itself sets them explicitly.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> - -<A NAME="constructor_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Constructor Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry()">DatabaseEntry</A></B>()</CODE> - -<BR> - Construct a DatabaseEntry with null data.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(byte[])">DatabaseEntry</A></B>(byte[] data)</CODE> - -<BR> - Construct a DatabaseEntry with a given byte array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(byte[], int, int)">DatabaseEntry</A></B>(byte[] data, - int offset, - int size)</CODE> - -<BR> - Constructs a DatabaseEntry with a given byte array, offset and size.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(java.nio.ByteBuffer)">DatabaseEntry</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data)</CODE> - -<BR> - Construct a DatabaseEntry with a given native I/O buffer.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry()">DatabaseEntry</a></strong>()</code> +<div class="block">Construct a DatabaseEntry with null data.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(byte[])">DatabaseEntry</a></strong>(byte[] data)</code> +<div class="block">Construct a DatabaseEntry with a given byte array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(byte[],%20int,%20int)">DatabaseEntry</a></strong>(byte[] data, + int offset, + int size)</code> +<div class="block">Constructs a DatabaseEntry with a given byte array, offset and size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#DatabaseEntry(java.nio.ByteBuffer)">DatabaseEntry</a></strong>(java.nio.ByteBuffer data)</code> +<div class="block">Construct a DatabaseEntry with a given native I/O buffer.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ========== METHOD SUMMARY =========== --> - -<A NAME="method_summary"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> -<B>Method Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#equals(java.lang.Object)">equals</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</CODE> - -<BR> - Compares the data of two entries for byte-by-byte equality.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> byte[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getData()">getData</A></B>()</CODE> - -<BR> - Return the byte array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getDataNIO()">getDataNIO</A></B>()</CODE> - -<BR> - Return the java.nio.ByteBuffer.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getOffset()">getOffset</A></B>()</CODE> - -<BR> - Return the byte offset into the data array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartial()">getPartial</A></B>()</CODE> - -<BR> - Return whether this DatabaseEntry is configured to read or write partial - records.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartialLength()">getPartialLength</A></B>()</CODE> - -<BR> - Return the byte length of the partial record being read or written by - the application, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getPartialOffset()">getPartialOffset</A></B>()</CODE> - -<BR> - Return the offset of the partial record being read or written by the - application, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getReadOnly()">getReadOnly</A></B>()</CODE> - -<BR> - Return whether this DatabaseEntry is configured as read only.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getRecordNumber()">getRecordNumber</A></B>()</CODE> - -<BR> - Return the record number encoded in this entry's buffer.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getReuseBuffer()">getReuseBuffer</A></B>()</CODE> - -<BR> - Return true if the whether the entry is configured to reuse the buffer.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getSize()">getSize</A></B>()</CODE> - -<BR> - Return the byte size of the data array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> boolean</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getUserBuffer()">getUserBuffer</A></B>()</CODE> - -<BR> - Return true if the whether the buffer in this entry is owned by the - application.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getUserBufferLength()">getUserBufferLength</A></B>()</CODE> - -<BR> - Return the length of the application's buffer.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#hashCode()">hashCode</A></B>()</CODE> - -<BR> - Returns a hash code based on the data value.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[])">setData</A></B>(byte[] data)</CODE> - -<BR> - Sets the byte array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[], int, int)">setData</A></B>(byte[] data, - int offset, - int size)</CODE> - -<BR> - Sets the byte array, offset and size.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer)">setDataNIO</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data)</CODE> - -<BR> - Sets the java.nio.ByteBuffer.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer, int, int)">setDataNIO</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data, - int offset, - int size)</CODE> - -<BR> - Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct - ByteBuffer,) offset and size.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setOffset(int)">setOffset</A></B>(int offset)</CODE> - -<BR> - Set the byte offset into the data array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(boolean)">setPartial</A></B>(boolean partial)</CODE> - -<BR> - Configure this DatabaseEntry to read or write partial records.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)">setPartial</A></B>(int doff, - int dlen, - boolean partial)</CODE> - -<BR> - Configures this DatabaseEntry to read or write partial records.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartialLength(int)">setPartialLength</A></B>(int dlen)</CODE> - -<BR> - Set the byte length of the partial record being read or written by - the application, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartialOffset(int)">setPartialOffset</A></B>(int doff)</CODE> - -<BR> - Set the offset of the partial record being read or written by the - application, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setReadOnly(boolean)">setReadOnly</A></B>(boolean readonly)</CODE> - -<BR> - Configure this DatabaseEntry as read only.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setRecordNumber(int)">setRecordNumber</A></B>(int recno)</CODE> - -<BR> - Initialize the entry from a logical record number.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setReuseBuffer(boolean)">setReuseBuffer</A></B>(boolean reuse)</CODE> - -<BR> - Configures the entry to try to reuse the buffer before allocating a new - one.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setSize(int)">setSize</A></B>(int size)</CODE> - -<BR> - Set the byte size of the data array.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> void</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int, boolean)">setUserBuffer</A></B>(int length, - boolean usermem)</CODE> - -<BR> - Configures the entry with an application-owned buffer.</TD> -</TR> -</TABLE> - <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> -<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> -</TR> -</TABLE> - -<P> - +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#equals(java.lang.Object)">equals</a></strong>(java.lang.Object o)</code> +<div class="block">Compares the data of two entries for byte-by-byte equality.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getBlob()">getBlob</a></strong>()</code> +<div class="block">Return whether this DatabaseEntry is configured to be stored as a blob.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>byte[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getData()">getData</a></strong>()</code> +<div class="block">Return the byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.nio.ByteBuffer</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getDataNIO()">getDataNIO</a></strong>()</code> +<div class="block">Return the java.nio.ByteBuffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getOffset()">getOffset</a></strong>()</code> +<div class="block">Return the byte offset into the data array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getPartial()">getPartial</a></strong>()</code> +<div class="block">Return whether this DatabaseEntry is configured to read or write partial + records.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getPartialLength()">getPartialLength</a></strong>()</code> +<div class="block">Return the byte length of the partial record being read or written by + the application, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getPartialOffset()">getPartialOffset</a></strong>()</code> +<div class="block">Return the offset of the partial record being read or written by the + application, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getReadOnly()">getReadOnly</a></strong>()</code> +<div class="block">Return whether this DatabaseEntry is configured as read only.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getRecordNumber()">getRecordNumber</a></strong>()</code> +<div class="block">Return the record number encoded in this entry's buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getReuseBuffer()">getReuseBuffer</a></strong>()</code> +<div class="block">Return true if the whether the entry is configured to reuse the buffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getSize()">getSize</a></strong>()</code> +<div class="block">Return the byte size of the data array.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getUserBuffer()">getUserBuffer</a></strong>()</code> +<div class="block">Return true if the whether the buffer in this entry is owned by the + application.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#getUserBufferLength()">getUserBufferLength</a></strong>()</code> +<div class="block">Return the length of the application's buffer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#hashCode()">hashCode</a></strong>()</code> +<div class="block">Returns a hash code based on the data value.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setBlob(boolean)">setBlob</a></strong>(boolean blob)</code> +<div class="block">Configure this DatabaseEntry to be stored as a blob.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[])">setData</a></strong>(byte[] data)</code> +<div class="block">Sets the byte array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setData(byte[],%20int,%20int)">setData</a></strong>(byte[] data, + int offset, + int size)</code> +<div class="block">Sets the byte array, offset and size.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer)">setDataNIO</a></strong>(java.nio.ByteBuffer data)</code> +<div class="block">Sets the java.nio.ByteBuffer.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setDataNIO(java.nio.ByteBuffer,%20int,%20int)">setDataNIO</a></strong>(java.nio.ByteBuffer data, + int offset, + int size)</code> +<div class="block">Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct + ByteBuffer,) offset and size.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setOffset(int)">setOffset</a></strong>(int offset)</code> +<div class="block">Set the byte offset into the data array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(boolean)">setPartial</a></strong>(boolean partial)</code> +<div class="block">Configure this DatabaseEntry to read or write partial records.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)">setPartial</a></strong>(int doff, + int dlen, + boolean partial)</code> +<div class="block">Configures this DatabaseEntry to read or write partial records.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartialLength(int)">setPartialLength</a></strong>(int dlen)</code> +<div class="block">Set the byte length of the partial record being read or written by + the application, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartialOffset(int)">setPartialOffset</a></strong>(int doff)</code> +<div class="block">Set the offset of the partial record being read or written by the + application, in bytes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setReadOnly(boolean)">setReadOnly</a></strong>(boolean readonly)</code> +<div class="block">Configure this DatabaseEntry as read only.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setRecordNumber(int)">setRecordNumber</a></strong>(int recno)</code> +<div class="block">Initialize the entry from a logical record number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setReuseBuffer(boolean)">setReuseBuffer</a></strong>(boolean reuse)</code> +<div class="block">Configures the entry to try to reuse the buffer before allocating a new + one.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setSize(int)">setSize</a></strong>(int size)</code> +<div class="block">Set the byte size of the data array.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int,%20boolean)">setUserBuffer</a></strong>(int length, + boolean usermem)</code> +<div class="block">Configures the entry with an application-owned buffer.</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, finalize, getClass, 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 ======== --> - -<A NAME="constructor_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Constructor Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="DatabaseEntry()"><!-- --></A><H3> -DatabaseEntry</H3> -<PRE> -public <B>DatabaseEntry</B>()</PRE> -<DL> -<DD>Construct a DatabaseEntry with null data. The offset and size are set to - zero. -<P> -</DL> -<HR> - -<A NAME="DatabaseEntry(byte[])"><!-- --></A><H3> -DatabaseEntry</H3> -<PRE> -public <B>DatabaseEntry</B>(byte[] data)</PRE> -<DL> -<DD>Construct a DatabaseEntry with a given byte array. The offset is +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DatabaseEntry()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DatabaseEntry</h4> +<pre>public DatabaseEntry()</pre> +<div class="block">Construct a DatabaseEntry with null data. The offset and size are set to + zero.</div> +</li> +</ul> +<a name="DatabaseEntry(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DatabaseEntry</h4> +<pre>public DatabaseEntry(byte[] data)</pre> +<div class="block">Construct a DatabaseEntry with a given byte array. The offset is set to zero; the size is set to the length of the array, or to zero if null is passed. - <p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - Byte array wrapped by the DatabaseEntry.</DL> -</DL> -<HR> - -<A NAME="DatabaseEntry(byte[], int, int)"><!-- --></A><H3> -DatabaseEntry</H3> -<PRE> -public <B>DatabaseEntry</B>(byte[] data, - int offset, - int size)</PRE> -<DL> -<DD>Constructs a DatabaseEntry with a given byte array, offset and size. - <p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - Byte array wrapped by the DatabaseEntry.<DD><CODE>offset</CODE> - Offset in the first byte in the byte array to be included.<DD><CODE>size</CODE> - Number of bytes in the byte array to be included.</DL> -</DL> -<HR> - -<A NAME="DatabaseEntry(java.nio.ByteBuffer)"><!-- --></A><H3> -DatabaseEntry</H3> -<PRE> -public <B>DatabaseEntry</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data)</PRE> -<DL> -<DD>Construct a DatabaseEntry with a given native I/O buffer. If the buffer is + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Byte array wrapped by the DatabaseEntry.</dd></dl> +</li> +</ul> +<a name="DatabaseEntry(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DatabaseEntry</h4> +<pre>public DatabaseEntry(byte[] data, + int offset, + int size)</pre> +<div class="block">Constructs a DatabaseEntry with a given byte array, offset and size. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Byte array wrapped by the DatabaseEntry.</dd><dd><code>offset</code> - Offset in the first byte in the byte array to be included.</dd><dd><code>size</code> - Number of bytes in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="DatabaseEntry(java.nio.ByteBuffer)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DatabaseEntry</h4> +<pre>public DatabaseEntry(java.nio.ByteBuffer data)</pre> +<div class="block">Construct a DatabaseEntry with a given native I/O buffer. If the buffer is non-direct, the buffer's backing array is used. If the buffer is direct, the DatabaseEntry is configured with an application-owned buffer whose length is set to the ByteBuffer's capacity less its position. The DatabaseEntry's size is set to the ByteBuffer's limit less its position and the offset is set to buffer's position (adjusted by arrayOffset if the buffer is non-direct.) - <p> -<P> -<DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - NIO byte buffer wrapped by the DatabaseEntry.</DL> -</DL> - + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - NIO byte buffer wrapped by the DatabaseEntry.</dd></dl> +</li> +</ul> +</li> +</ul> <!-- ============ METHOD DETAIL ========== --> - -<A NAME="method_detail"><!-- --></A> -<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> -<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> -<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> -<B>Method Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="getData()"><!-- --></A><H3> -getData</H3> -<PRE> -public byte[] <B>getData</B>()</PRE> -<DL> -<DD>Return the byte array. +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setBlob(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlob</h4> +<pre>public void setBlob(boolean blob)</pre> +<div class="block">Configure this DatabaseEntry to be stored as a blob. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>blob</code> - Whether this DatabaseEntry is configured to be stored as a blob.</dd></dl> +</li> +</ul> +<a name="getBlob()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlob</h4> +<pre>public boolean getBlob()</pre> +<div class="block">Return whether this DatabaseEntry is configured to be stored as a blob. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this DatabaseEntry is configured to be stored as a blob.</dd></dl> +</li> +</ul> +<a name="getData()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getData</h4> +<pre>public byte[] getData()</pre> +<div class="block">Return the byte array. <p> For a DatabaseEntry that is used as an output parameter, the byte array will always be a newly allocated array. The byte array specified by the caller will not be used and may be null. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The byte array.</DL> -</DD> -</DL> -<HR> - -<A NAME="getDataNIO()"><!-- --></A><H3> -getDataNIO</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> <B>getDataNIO</B>()</PRE> -<DL> -<DD>Return the java.nio.ByteBuffer. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The byte array.</dd></dl> +</li> +</ul> +<a name="getDataNIO()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDataNIO</h4> +<pre>public java.nio.ByteBuffer getDataNIO()</pre> +<div class="block">Return the java.nio.ByteBuffer. <p> Used to access the underlying data when the DatabaseEntry is configured to utilize a java.nio.ByteBuffer. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The underlying java.nio.ByteBuffer.</DL> -</DD> -</DL> -<HR> - -<A NAME="setData(byte[], int, int)"><!-- --></A><H3> -setData</H3> -<PRE> -public void <B>setData</B>(byte[] data, - int offset, - int size)</PRE> -<DL> -<DD>Sets the byte array, offset and size. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - Byte array wrapped by the DatabaseEntry.<DD><CODE>offset</CODE> - Offset in the first byte in the byte array to be included.<DD><CODE>size</CODE> - Number of bytes in the byte array to be included.</DL> -</DD> -</DL> -<HR> - -<A NAME="setData(byte[])"><!-- --></A><H3> -setData</H3> -<PRE> -public void <B>setData</B>(byte[] data)</PRE> -<DL> -<DD>Sets the byte array. The offset is set to zero; the size is set to the + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The underlying java.nio.ByteBuffer.</dd></dl> +</li> +</ul> +<a name="setData(byte[], int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public void setData(byte[] data, + int offset, + int size)</pre> +<div class="block">Sets the byte array, offset and size. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Byte array wrapped by the DatabaseEntry.</dd><dd><code>offset</code> - Offset in the first byte in the byte array to be included.</dd><dd><code>size</code> - Number of bytes in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="setData(byte[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setData</h4> +<pre>public void setData(byte[] data)</pre> +<div class="block">Sets the byte array. The offset is set to zero; the size is set to the length of the array, or to zero if null is passed. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - Byte array wrapped by the DatabaseEntry.</DL> -</DD> -</DL> -<HR> - -<A NAME="setDataNIO(java.nio.ByteBuffer, int, int)"><!-- --></A><H3> -setDataNIO</H3> -<PRE> -public void <B>setDataNIO</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data, - int offset, - int size)</PRE> -<DL> -<DD>Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - Byte array wrapped by the DatabaseEntry.</dd></dl> +</li> +</ul> +<a name="setDataNIO(java.nio.ByteBuffer, int, int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataNIO</h4> +<pre>public void setDataNIO(java.nio.ByteBuffer data, + int offset, + int size)</pre> +<div class="block">Sets the java.nio.ByteBuffer (or the backing array if passed a non-direct ByteBuffer,) offset and size. If passed a direct ByteBuffer, the entry is configured with an application-owned buffer whose length is set to the ByteBuffer's capacity less the offset. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - java.nio.ByteBuffer wrapped by the DatabaseEntry.<DD><CODE>offset</CODE> - int offset into the ByteBuffer where the DatabaseEntry data begins.<DD><CODE>size</CODE> - int size of the ByteBuffer available.</DL> -</DD> -</DL> -<HR> - -<A NAME="setDataNIO(java.nio.ByteBuffer)"><!-- --></A><H3> -setDataNIO</H3> -<PRE> -public void <B>setDataNIO</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</A> data)</PRE> -<DL> -<DD>Sets the java.nio.ByteBuffer. The offset is set to the ByteBuffer's + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - java.nio.ByteBuffer wrapped by the DatabaseEntry.</dd><dd><code>offset</code> - int offset into the ByteBuffer where the DatabaseEntry data begins.</dd><dd><code>size</code> - int size of the ByteBuffer available.</dd></dl> +</li> +</ul> +<a name="setDataNIO(java.nio.ByteBuffer)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDataNIO</h4> +<pre>public void setDataNIO(java.nio.ByteBuffer data)</pre> +<div class="block">Sets the java.nio.ByteBuffer. The offset is set to the ByteBuffer's position; the size is set to the ByteBuffer's limit less its position, or to zero if null is passed. If the ByteBuffer is non-direct, the backing array will be used. If passed a direct ByteBuffer, the entry is configured with an application-owned buffer whose length is set to the ByteBuffer's capacity - less its current position. No call to <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int, boolean)"><CODE>setUserBuffer(int, boolean)</CODE></A> is required + less its current position. No call to <a href="../../../com/sleepycat/db/DatabaseEntry.html#setUserBuffer(int,%20boolean)"><code>setUserBuffer(int, boolean)</code></a> is required after setting the ByteBuffer. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>data</CODE> - java.nio.ByteBuffer wrapped by the DatabaseEntry.</DL> -</DD> -</DL> -<HR> - -<A NAME="getOffset()"><!-- --></A><H3> -getOffset</H3> -<PRE> -public int <B>getOffset</B>()</PRE> -<DL> -<DD>Return the byte offset into the data array. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>data</code> - java.nio.ByteBuffer wrapped by the DatabaseEntry.</dd></dl> +</li> +</ul> +<a name="getOffset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getOffset</h4> +<pre>public int getOffset()</pre> +<div class="block">Return the byte offset into the data array. <p> For a DatabaseEntry that is used as an output parameter, the offset will always be zero. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Offset in the first byte in the byte array to be included.</DL> -</DD> -</DL> -<HR> - -<A NAME="setOffset(int)"><!-- --></A><H3> -setOffset</H3> -<PRE> -public void <B>setOffset</B>(int offset)</PRE> -<DL> -<DD>Set the byte offset into the data array. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>offset</CODE> - Offset in the first byte in the byte array to be included.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPartialLength()"><!-- --></A><H3> -getPartialLength</H3> -<PRE> -public int <B>getPartialLength</B>()</PRE> -<DL> -<DD>Return the byte length of the partial record being read or written by + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Offset in the first byte in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="setOffset(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setOffset</h4> +<pre>public void setOffset(int offset)</pre> +<div class="block">Set the byte offset into the data array. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>offset</code> - Offset in the first byte in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="getPartialLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartialLength</h4> +<pre>public int getPartialLength()</pre> +<div class="block">Return the byte length of the partial record being read or written by the application, in bytes. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The byte length of the partial record being read or written by the + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The byte length of the partial record being read or written by the application, in bytes. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getPartialOffset()"><!-- --></A><H3> -getPartialOffset</H3> -<PRE> -public int <B>getPartialOffset</B>()</PRE> -<DL> -<DD>Return the offset of the partial record being read or written by the + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a></dd></dl> +</li> +</ul> +<a name="getPartialOffset()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartialOffset</h4> +<pre>public int getPartialOffset()</pre> +<div class="block">Return the offset of the partial record being read or written by the application, in bytes. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The offset of the partial record being read or written by the + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The offset of the partial record being read or written by the application, in bytes. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="getPartial()"><!-- --></A><H3> -getPartial</H3> -<PRE> -public boolean <B>getPartial</B>()</PRE> -<DL> -<DD>Return whether this DatabaseEntry is configured to read or write partial + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a></dd></dl> +</li> +</ul> +<a name="getPartial()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartial</h4> +<pre>public boolean getPartial()</pre> +<div class="block">Return whether this DatabaseEntry is configured to read or write partial records. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Whether this DatabaseEntry is configured to read or write partial + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this DatabaseEntry is configured to read or write partial records. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setPartialOffset(int)"><!-- --></A><H3> -setPartialOffset</H3> -<PRE> -public void <B>setPartialOffset</B>(int doff)</PRE> -<DL> -<DD>Set the offset of the partial record being read or written by the + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setPartialOffset(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartialOffset</h4> +<pre>public void setPartialOffset(int doff)</pre> +<div class="block">Set the offset of the partial record being read or written by the application, in bytes. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>doff</CODE> - The offset of the partial record being read or written by the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doff</code> - The offset of the partial record being read or written by the application, in bytes. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setPartialLength(int)"><!-- --></A><H3> -setPartialLength</H3> -<PRE> -public void <B>setPartialLength</B>(int dlen)</PRE> -<DL> -<DD>Set the byte length of the partial record being read or written by + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setPartialLength(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartialLength</h4> +<pre>public void setPartialLength(int dlen)</pre> +<div class="block">Set the byte length of the partial record being read or written by the application, in bytes. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>dlen</CODE> - The byte length of the partial record being read or written by the - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>application, in bytes.</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setPartial(boolean)"><!-- --></A><H3> -setPartial</H3> -<PRE> -public void <B>setPartial</B>(boolean partial)</PRE> -<DL> -<DD>Configure this DatabaseEntry to read or write partial records. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dlen</code> - The byte length of the partial record being read or written by the + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>application, in bytes.</code></a></dd></dl> +</li> +</ul> +<a name="setPartial(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartial</h4> +<pre>public void setPartial(boolean partial)</pre> +<div class="block">Configure this DatabaseEntry to read or write partial records. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>partial</CODE> - Whether this DatabaseEntry is configured to read or write partial + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>partial</code> - Whether this DatabaseEntry is configured to read or write partial records. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int, int, boolean)"><CODE>setPartial(int,int,boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setPartial(int, int, boolean)"><!-- --></A><H3> -setPartial</H3> -<PRE> -public void <B>setPartial</B>(int doff, - int dlen, - boolean partial)</PRE> -<DL> -<DD>Configures this DatabaseEntry to read or write partial records. + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setPartial(int,%20int,%20boolean)"><code>setPartial(int,int,boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setPartial(int, int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartial</h4> +<pre>public void setPartial(int doff, + int dlen, + boolean partial)</pre> +<div class="block">Configures this DatabaseEntry to read or write partial records. <p> Do partial retrieval or storage of an item. If the calling application is doing a retrieval, length bytes specified by @@ -863,195 +808,167 @@ public void <B>setPartial</B>(int doff, It is an error to specify a partial key when performing a put operation of any kind. <p> - It is an error to attempt a partial store using the <A HREF="../../../com/sleepycat/db/Database.html#put(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>Database.put</CODE></A> method in a database that supports duplicate records. Partial + It is an error to attempt a partial store using the <a href="../../../com/sleepycat/db/Database.html#put(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)"><code>Database.put</code></a> method in a database that supports duplicate records. Partial stores in databases supporting duplicate records must be done using a cursor method. <p> Note that the Partial properties are set only by the caller. They will never be set by a Database or Cursor method. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>doff</CODE> - The offset of the partial record being read or written by the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>doff</code> - The offset of the partial record being read or written by the application, in bytes. - <p><DD><CODE>dlen</CODE> - The byte length of the partial record being read or written by the + <p></dd><dd><code>dlen</code> - The byte length of the partial record being read or written by the application, in bytes. - <p><DD><CODE>partial</CODE> - Whether this DatabaseEntry is configured to read or write partial - records.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReadOnly()"><!-- --></A><H3> -getReadOnly</H3> -<PRE> -public boolean <B>getReadOnly</B>()</PRE> -<DL> -<DD>Return whether this DatabaseEntry is configured as read only. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Whether this DatabaseEntry is configured as read only. - <p><DT><B>See Also:</B><DD><A HREF="../../../com/sleepycat/db/DatabaseEntry.html#setReadOnly(boolean)"><CODE>setReadOnly(boolean)</CODE></A></DL> -</DD> -</DL> -<HR> - -<A NAME="setReadOnly(boolean)"><!-- --></A><H3> -setReadOnly</H3> -<PRE> -public void <B>setReadOnly</B>(boolean readonly)</PRE> -<DL> -<DD>Configure this DatabaseEntry as read only. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>readonly</CODE> - Whether this DatabaseEntry is configured as read only.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordNumber()"><!-- --></A><H3> -getRecordNumber</H3> -<PRE> -public int <B>getRecordNumber</B>()</PRE> -<DL> -<DD>Return the record number encoded in this entry's buffer. + <p></dd><dd><code>partial</code> - Whether this DatabaseEntry is configured to read or write partial + records.</dd></dl> +</li> +</ul> +<a name="getReadOnly()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadOnly</h4> +<pre>public boolean getReadOnly()</pre> +<div class="block">Return whether this DatabaseEntry is configured as read only. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Whether this DatabaseEntry is configured as read only. + <p></dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../com/sleepycat/db/DatabaseEntry.html#setReadOnly(boolean)"><code>setReadOnly(boolean)</code></a></dd></dl> +</li> +</ul> +<a name="setReadOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadOnly</h4> +<pre>public void setReadOnly(boolean readonly)</pre> +<div class="block">Configure this DatabaseEntry as read only. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readonly</code> - Whether this DatabaseEntry is configured as read only.</dd></dl> +</li> +</ul> +<a name="getRecordNumber()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordNumber</h4> +<pre>public int getRecordNumber()</pre> +<div class="block">Return the record number encoded in this entry's buffer. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The record number encoded in this entry's buffer.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordNumber(int)"><!-- --></A><H3> -setRecordNumber</H3> -<PRE> -public void <B>setRecordNumber</B>(int recno)</PRE> -<DL> -<DD>Initialize the entry from a logical record number. Record numbers +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The record number encoded in this entry's buffer.</dd></dl> +</li> +</ul> +<a name="setRecordNumber(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordNumber</h4> +<pre>public void setRecordNumber(int recno)</pre> +<div class="block">Initialize the entry from a logical record number. Record numbers are integer keys starting at 1. When this method is called the data, size and offset fields are implicitly set to hold a byte array - representation of the integer key. -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recno</CODE> - the record number to be encoded</DL> -</DD> -</DL> -<HR> - -<A NAME="getReuseBuffer()"><!-- --></A><H3> -getReuseBuffer</H3> -<PRE> -public boolean <B>getReuseBuffer</B>()</PRE> -<DL> -<DD>Return true if the whether the entry is configured to reuse the buffer. + representation of the integer key.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recno</code> - the record number to be encoded</dd></dl> +</li> +</ul> +<a name="getReuseBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReuseBuffer</h4> +<pre>public boolean getReuseBuffer()</pre> +<div class="block">Return true if the whether the entry is configured to reuse the buffer. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the whether the entry is configured to reuse the buffer.</DL> -</DD> -</DL> -<HR> - -<A NAME="setReuseBuffer(boolean)"><!-- --></A><H3> -setReuseBuffer</H3> -<PRE> -public void <B>setReuseBuffer</B>(boolean reuse)</PRE> -<DL> -<DD>Configures the entry to try to reuse the buffer before allocating a new +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the whether the entry is configured to reuse the buffer.</dd></dl> +</li> +</ul> +<a name="setReuseBuffer(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReuseBuffer</h4> +<pre>public void setReuseBuffer(boolean reuse)</pre> +<div class="block">Configures the entry to try to reuse the buffer before allocating a new one. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>reuse</CODE> - whether to reuse the buffer</DL> -</DD> -</DL> -<HR> - -<A NAME="getSize()"><!-- --></A><H3> -getSize</H3> -<PRE> -public int <B>getSize</B>()</PRE> -<DL> -<DD>Return the byte size of the data array. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reuse</code> - whether to reuse the buffer</dd></dl> +</li> +</ul> +<a name="getSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSize</h4> +<pre>public int getSize()</pre> +<div class="block">Return the byte size of the data array. <p> For a DatabaseEntry that is used as an output parameter, the size will always be the length of the data array. - <p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>Number of bytes in the byte array to be included.</DL> -</DD> -</DL> -<HR> - -<A NAME="setSize(int)"><!-- --></A><H3> -setSize</H3> -<PRE> -public void <B>setSize</B>(int size)</PRE> -<DL> -<DD>Set the byte size of the data array. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>size</CODE> - Number of bytes in the byte array to be included.</DL> -</DD> -</DL> -<HR> - -<A NAME="getUserBuffer()"><!-- --></A><H3> -getUserBuffer</H3> -<PRE> -public boolean <B>getUserBuffer</B>()</PRE> -<DL> -<DD>Return true if the whether the buffer in this entry is owned by the + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Number of bytes in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="setSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSize</h4> +<pre>public void setSize(int size)</pre> +<div class="block">Set the byte size of the data array. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>size</code> - Number of bytes in the byte array to be included.</dd></dl> +</li> +</ul> +<a name="getUserBuffer()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserBuffer</h4> +<pre>public boolean getUserBuffer()</pre> +<div class="block">Return true if the whether the buffer in this entry is owned by the application. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the whether the buffer in this entry is owned by the - application.</DL> -</DD> -</DL> -<HR> - -<A NAME="getUserBufferLength()"><!-- --></A><H3> -getUserBufferLength</H3> -<PRE> -public int <B>getUserBufferLength</B>()</PRE> -<DL> -<DD>Return the length of the application's buffer. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the whether the buffer in this entry is owned by the + application.</dd></dl> +</li> +</ul> +<a name="getUserBufferLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUserBufferLength</h4> +<pre>public int getUserBufferLength()</pre> +<div class="block">Return the length of the application's buffer. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> - -<DT><B>Returns:</B><DD>The length of the application's buffer.</DL> -</DD> -</DL> -<HR> - -<A NAME="setUserBuffer(int, boolean)"><!-- --></A><H3> -setUserBuffer</H3> -<PRE> -public void <B>setUserBuffer</B>(int length, - boolean usermem)</PRE> -<DL> -<DD>Configures the entry with an application-owned buffer. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The length of the application's buffer.</dd></dl> +</li> +</ul> +<a name="setUserBuffer(int, boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUserBuffer</h4> +<pre>public void setUserBuffer(int length, + boolean usermem)</pre> +<div class="block">Configures the entry with an application-owned buffer. <p> The <code>data</code> field of the entry must refer to a buffer that is at least <code>length</code> bytes in length. @@ -1060,26 +977,24 @@ public void <B>setUserBuffer</B>(int length, of bytes, the item is copied into the memory to which the <code>data</code> field refers. Otherwise, the <code>size</code> field is set to the length needed for the requested item, and a - <A HREF="../../../com/sleepycat/db/MemoryException.html" title="class in com.sleepycat.db"><CODE>MemoryException</CODE></A> is thrown. + <a href="../../../com/sleepycat/db/MemoryException.html" title="class in com.sleepycat.db"><code>MemoryException</code></a> is thrown. <p> Applications can determine the length of a record by setting - <code>length</code> to 0 and calling <A HREF="../../../com/sleepycat/db/DatabaseEntry.html#getSize()"><CODE>DatabaseEntry.getSize</CODE></A> + <code>length</code> to 0 and calling <a href="../../../com/sleepycat/db/DatabaseEntry.html#getSize()"><code>DatabaseEntry.getSize</code></a> on the return value. - <p> -<P> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>length</CODE> - the length of the buffer - <p><DD><CODE>usermem</CODE> - whether the buffer is owned by the application</DL> -</DD> -</DL> -<HR> - -<A NAME="equals(java.lang.Object)"><!-- --></A><H3> -equals</H3> -<PRE> -public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A> o)</PRE> -<DL> -<DD>Compares the data of two entries for byte-by-byte equality. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>length</code> - the length of the buffer + <p></dd><dd><code>usermem</code> - whether the buffer is owned by the application</dd></dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>public boolean equals(java.lang.Object o)</pre> +<div class="block">Compares the data of two entries for byte-by-byte equality. <p>In either entry, if the offset is non-zero or the size is not equal to the data array length, then only the data bounded by these values is @@ -1091,92 +1006,95 @@ public boolean <B>equals</B>(<A HREF="http://download.oracle.com/javase/1.5.0/do <p>If the partial property is set in either entry, then to be considered equal both entries must have the same partial properties: partial, - partialOffset and partialLength. -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="hashCode()"><!-- --></A><H3> -hashCode</H3> -<PRE> -public int <B>hashCode</B>()</PRE> -<DL> -<DD>Returns a hash code based on the data value. -<P> -<DD><DL> -<DT><B>Overrides:</B><DD><CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A></CODE> in class <CODE><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></CODE></DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> + partialOffset and partialLength.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>equals</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>public int hashCode()</pre> +<div class="block">Returns a hash code based on the data value.</div> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> <!-- ========= END OF CLASS DATA ========= --> -<HR> - - <!-- ======= START OF BOTTOM NAVBAR ====== --> -<A NAME="navbar_bottom"><!-- --></A> -<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> -<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> -<TR> -<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> -<A NAME="navbar_bottom_firstrow"><!-- --></A> -<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> - <TR ALIGN="center" VALIGN="top"> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> - <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/DatabaseEntry.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> - <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> - </TR> -</TABLE> -</TD> -<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> -<b>Berkeley DB</b><br><font size="-1"> version 5.3.21</font></EM> -</TD> -</TR> - -<TR> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> -<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> - <A HREF="../../../index.html?com/sleepycat/db/DatabaseEntry.html" target="_top"><B>FRAMES</B></A> - <A HREF="DatabaseEntry.html" target="_top"><B>NO FRAMES</B></A> - <SCRIPT type="text/javascript"> - <!-- +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/DatabaseEntry.html">Use</a></li> +<li><a href="package-tree.html">Tree</a></li> +<li><a href="../../../deprecated-list.html">Deprecated</a></li> +<li><a href="../../../index-all.html">Index</a></li> +<li><a href="../../../help-doc.html">Help</a></li> +</ul> +<div class="aboutLanguage"><em><b>Berkeley DB</b><br><font size="-1"> version 6.1.23</font></em></div> +</div> +<div class="subNav"> +<ul class="navList"> +<li><a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?com/sleepycat/db/DatabaseEntry.html" target="_top">Frames</a></li> +<li><a href="DatabaseEntry.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { - document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; } //--> -</SCRIPT> -<NOSCRIPT> - <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> -</NOSCRIPT> - - -</FONT></TD> -</TR> -<TR> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> - SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> -</TR> -</TABLE> -<A NAME="skip-navbar_bottom"></A> +</script> +</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 ======= --> - -<HR> -<font size=1>Copyright (c) 1996, 2012 Oracle and/or its affiliates. All rights reserved.</font> -</BODY> -</HTML> +<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2015 Oracle and/or its affiliates. All rights reserved.</font></small></p> +</body> +</html> |