diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/DatabaseConfig.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/DatabaseConfig.html | 5940 |
1 files changed, 2612 insertions, 3328 deletions
diff --git a/docs/java/com/sleepycat/db/DatabaseConfig.html b/docs/java/com/sleepycat/db/DatabaseConfig.html index 28a1efde..2c3df53e 100644 --- a/docs/java/com/sleepycat/db/DatabaseConfig.html +++ b/docs/java/com/sleepycat/db/DatabaseConfig.html @@ -1,1253 +1,1126 @@ <!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> -DatabaseConfig (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>DatabaseConfig (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="DatabaseConfig (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/DatabaseConfig.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/Database.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/DatabaseEntry.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/DatabaseConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="DatabaseConfig.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/DatabaseConfig.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/Database.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseEntry.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/DatabaseConfig.html" target="_top">Frames</a></li> +<li><a href="DatabaseConfig.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 DatabaseConfig</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.DatabaseConfig</B> -</PRE> -<DL> -<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DD> -</DL> -<DL> -<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</A></DD> -</DL> -<HR> -<DL> -<DT><PRE>public class <B>DatabaseConfig</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><DT>implements <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Cloneable.html?is-external=true" title="class or interface in java.lang">Cloneable</A></DL> -</PRE> - -<P> -Specify the attributes of a database. -<P> - -<P> -<HR> - -<P> +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class DatabaseConfig" class="title">Class DatabaseConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.DatabaseConfig</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd>java.lang.Cloneable</dd> +</dl> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../com/sleepycat/db/SecondaryConfig.html" title="class in com.sleepycat.db">SecondaryConfig</a></dd> +</dl> +<hr> +<br> +<pre>public class <span class="strong">DatabaseConfig</span> +extends java.lang.Object +implements java.lang.Cloneable</pre> +<div class="block">Specify the attributes of a database.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> <!-- =========== FIELD SUMMARY =========== --> - -<A NAME="field_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>Field Summary</B></FONT></TH> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE>static <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#DEFAULT">DEFAULT</A></B></CODE> - -<BR> - An instance created using the default constructor is initialized - with the system's default settings.</TD> -</TR> -</TABLE> - +<ul class="blockList"> +<li class="blockList"><a name="field_summary"> +<!-- --> +</a> +<h3>Field Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> +<caption><span>Fields</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Field and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>static <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#DEFAULT">DEFAULT</a></strong></code> +<div class="block">An instance created using the default constructor is initialized + with the system's default settings.</div> +</td> +</tr> +</table> +</li> +</ul> <!-- ======== 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/DatabaseConfig.html#DatabaseConfig()">DatabaseConfig</A></B>()</CODE> - -<BR> - An instance created using the default constructor is initialized with - the system's default settings.</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/DatabaseConfig.html#DatabaseConfig()">DatabaseConfig</a></strong>()</code> +<div class="block">An instance created using the default constructor is initialized with + the system's default settings.</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> <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#cloneConfig()">cloneConfig</A></B>()</CODE> - -<BR> - Returns a copy of this configuration object.</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/DatabaseConfig.html#getAllowCreate()">getAllowCreate</A></B>()</CODE> - -<BR> - Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured - to create the database if it does not already exist.</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/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeComparator()">getBtreeComparator</A></B>()</CODE> - -<BR> - Return the custom Comparator used for btree keys.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeCompressor()">getBtreeCompressor</A></B>()</CODE> - -<BR> - Get the Btree compression callbacks.</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/DatabaseConfig.html#getBtreeMinKey()">getBtreeMinKey</A></B>()</CODE> - -<BR> - Return the minimum number of key/data pairs intended to be stored - on any single Btree leaf page.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getBtreePrefixCalculator()">getBtreePrefixCalculator</A></B>()</CODE> - -<BR> - Return the Btree prefix callback.</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/DatabaseConfig.html#getBtreeRecordNumbers()">getBtreeRecordNumbers</A></B>()</CODE> - -<BR> - Return true if the Btree is configured to support retrieval by record number.</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/DatabaseConfig.html#getByteOrder()">getByteOrder</A></B>()</CODE> - -<BR> - Return the database byte order; a byte order of 4,321 indicates a +<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><a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#cloneConfig()">cloneConfig</a></strong>()</code> +<div class="block">Returns a copy of this configuration object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getAllowCreate()">getAllowCreate</a></strong>()</code> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured + to create the database if it does not already exist.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBlobDir()">getBlobDir</a></strong>()</code> +<div class="block">Returns the path of a directory where blobs are stored.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBlobThreshold()">getBlobThreshold</a></strong>()</code> +<div class="block">Return the threshold value in bytes beyond which data items are + stored as blobs.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeComparator()">getBtreeComparator</a></strong>()</code> +<div class="block">Return the custom Comparator used for btree keys.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeCompressor()">getBtreeCompressor</a></strong>()</code> +<div class="block">Get the Btree compression callbacks.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeMinKey()">getBtreeMinKey</a></strong>()</code> +<div class="block">Return the minimum number of key/data pairs intended to be stored + on any single Btree leaf page.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreePrefixCalculator()">getBtreePrefixCalculator</a></strong>()</code> +<div class="block">Return the Btree prefix callback.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getBtreeRecordNumbers()">getBtreeRecordNumbers</a></strong>()</code> +<div class="block">Return true if the Btree is configured to support retrieval by record number.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getByteOrder()">getByteOrder</a></strong>()</code> +<div class="block">Return the database byte order; a byte order of 4,321 indicates a big endian order, and a byte order of 1,234 indicates a little - endian order.</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/DatabaseConfig.html#getByteSwapped()">getByteSwapped</A></B>()</CODE> - -<BR> - Return if the underlying database files were created on an architecture - of the same byte order as the current one.</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/DatabaseConfig.html#getCacheCount()">getCacheCount</A></B>()</CODE> - -<BR> - Return the number of shared memory buffer pools, that is, the number - of caches.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getCacheSize()">getCacheSize</A></B>()</CODE> - -<BR> - Return the size of the shared memory buffer pool, that is, the cache.</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/DatabaseConfig.html#getChecksum()">getChecksum</A></B>()</CODE> - -<BR> - Return true if the database environment is configured to do checksum + endian order.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getByteSwapped()">getByteSwapped</a></strong>()</code> +<div class="block">Return if the underlying database files were created on an architecture + of the same byte order as the current one.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getCacheCount()">getCacheCount</a></strong>()</code> +<div class="block">Return the number of shared memory buffer pools, that is, the number + of caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getCacheSize()">getCacheSize</a></strong>()</code> +<div class="block">Return the size of the shared memory buffer pool, that is, the cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getChecksum()">getChecksum</a></strong>()</code> +<div class="block">Return true if the database environment is configured to do checksum verification of pages read into the cache from the backing - filestore.</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/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getCreateDir()">getCreateDir</A></B>()</CODE> - -<BR> - Return the directory a database will/has been created in or looked for.</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/DatabaseConfig.html#getDirtyRead()">getDirtyRead</A></B>()</CODE> - -<BR> - <B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><CODE>getReadUncommitted()</CODE></A> to conform to ANSI - database isolation terminology.</I></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/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getDuplicateComparator()">getDuplicateComparator</A></B>()</CODE> - -<BR> - Return the duplicate data item comparison callback.</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/DatabaseConfig.html#getEncrypted()">getEncrypted</A></B>()</CODE> - -<BR> - Return true if the database has been configured to perform encryption.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorHandler()">getErrorHandler</A></B>()</CODE> - -<BR> - Return the function to be called if an error occurs.</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/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorPrefix()">getErrorPrefix</A></B>()</CODE> - -<BR> - Return the prefix string that appears before error messages.</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/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getErrorStream()">getErrorStream</A></B>()</CODE> - -<BR> - Return the an OutputStream for displaying error messages.</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/DatabaseConfig.html#getExclusiveCreate()">getExclusiveCreate</A></B>()</CODE> - -<BR> - Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured - to fail if the database already exists.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getFeedbackHandler()">getFeedbackHandler</A></B>()</CODE> - -<BR> - Return the object's methods to be called to provide feedback.</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/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHashComparator()">getHashComparator</A></B>()</CODE> - -<BR> - Return the Comparator used to compare keys in a Hash database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHasher()">getHasher</A></B>()</CODE> - -<BR> - Return the database-specific hash function.</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/DatabaseConfig.html#getHashFillFactor()">getHashFillFactor</A></B>()</CODE> - -<BR> - Return the hash table density.</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/DatabaseConfig.html#getHashNumElements()">getHashNumElements</A></B>()</CODE> - -<BR> - Return the estimate of the final size of the hash table.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHeapRegionSize()">getHeapRegionSize</A></B>()</CODE> - -<BR> - Return the number of pages in a region of the database.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getHeapsize()">getHeapsize</A></B>()</CODE> - -<BR> - Return the maximum on-disk database file size.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMessageHandler()">getMessageHandler</A></B>()</CODE> - -<BR> - Return the function to be called with an informational message.</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/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMessageStream()">getMessageStream</A></B>()</CODE> - -<BR> - Return the an OutputStream for displaying informational messages.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> long</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getMode()">getMode</A></B>()</CODE> - -<BR> - Return the mode used to create files.</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/DatabaseConfig.html#getMultiversion()">getMultiversion</A></B>()</CODE> - -<BR> - Return true if the database is configured for multiversion concurrency control.</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/DatabaseConfig.html#getNoMMap()">getNoMMap</A></B>()</CODE> - -<BR> - Return true if the library is configured to not map this database into - memory.</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/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getNoWaitDbExclusiveLock()">getNoWaitDbExclusiveLock</A></B>()</CODE> - -<BR> - Return whether the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle is -configured to obtain a write lock on the entire database.</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/DatabaseConfig.html#getPageSize()">getPageSize</A></B>()</CODE> - -<BR> - Return the size of the pages used to hold items in the database, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPanicHandler()">getPanicHandler</A></B>()</CODE> - -<BR> - Return the function to be called if the database environment panics.</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/io/File.html?is-external=true" title="class or interface in java.io">File</A>[]</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionDirs()">getPartitionDirs</A></B>()</CODE> - -<BR> - Return the array of directories the database extents should be created in or -looked for.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionHandler()">getPartitionHandler</A></B>()</CODE> - -<BR> - Return the function to be called to determine which partition a key resides in.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionKeys()">getPartitionKeys</A></B>()</CODE> - -<BR> - Return the array of keys the database is configured to partition with.</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/DatabaseConfig.html#getPartitionParts()">getPartitionParts</A></B>()</CODE> - -<BR> - Return the number of partitions the database is configured for.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getPriority()">getPriority</A></B>()</CODE> - -<BR> - Return the the cache priority for pages referenced by this handle.</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/DatabaseConfig.html#getQueueExtentSize()">getQueueExtentSize</A></B>()</CODE> - -<BR> - Return the size of the extents used to hold pages in a Queue database, - specified as a number of pages.</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/DatabaseConfig.html#getQueueInOrder()">getQueueInOrder</A></B>()</CODE> - -<BR> - Return true if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return + filestore.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getCreateDir()">getCreateDir</a></strong>()</code> +<div class="block">Return the directory a database will/has been created in or looked for.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getDirtyRead()">getDirtyRead</a></strong>()</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This has been replaced by <a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><code>getReadUncommitted()</code></a> to conform to ANSI + database isolation terminology.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.util.Comparator</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getDuplicateComparator()">getDuplicateComparator</a></strong>()</code> +<div class="block">Return the duplicate data item comparison callback.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getEncrypted()">getEncrypted</a></strong>()</code> +<div class="block">Return true if the database has been configured to perform encryption.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorHandler()">getErrorHandler</a></strong>()</code> +<div class="block">Return the function to be called if an error occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.lang.String</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorPrefix()">getErrorPrefix</a></strong>()</code> +<div class="block">Return the prefix string that appears before error messages.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getErrorStream()">getErrorStream</a></strong>()</code> +<div class="block">Return the an OutputStream for displaying error messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getExclusiveCreate()">getExclusiveCreate</a></strong>()</code> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured + to fail if the database already exists.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getFeedbackHandler()">getFeedbackHandler</a></strong>()</code> +<div class="block">Return the object's methods to be called to provide feedback.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.util.Comparator</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashComparator()">getHashComparator</a></strong>()</code> +<div class="block">Return the Comparator used to compare keys in a Hash database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHasher()">getHasher</a></strong>()</code> +<div class="block">Return the database-specific hash function.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashFillFactor()">getHashFillFactor</a></strong>()</code> +<div class="block">Return the hash table density.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHashNumElements()">getHashNumElements</a></strong>()</code> +<div class="block">Return the estimate of the final size of the hash table.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHeapRegionSize()">getHeapRegionSize</a></strong>()</code> +<div class="block">Return the number of pages in a region of the database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getHeapsize()">getHeapsize</a></strong>()</code> +<div class="block">Return the maximum on-disk database file size.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getMessageHandler()">getMessageHandler</a></strong>()</code> +<div class="block">Return the function to be called with an informational message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.OutputStream</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getMessageStream()">getMessageStream</a></strong>()</code> +<div class="block">Return the an OutputStream for displaying informational messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getMode()">getMode</a></strong>()</code> +<div class="block">Return the mode used to create files.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getMultiversion()">getMultiversion</a></strong>()</code> +<div class="block">Return true if the database is configured for multiversion concurrency control.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getNoMMap()">getNoMMap</a></strong>()</code> +<div class="block">Return true if the library is configured to not map this database into + memory.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.lang.Boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getNoWaitDbExclusiveLock()">getNoWaitDbExclusiveLock</a></strong>()</code> +<div class="block">Return whether the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is +configured to obtain a write lock on the entire database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPageSize()">getPageSize</a></strong>()</code> +<div class="block">Return the size of the pages used to hold items in the database, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPanicHandler()">getPanicHandler</a></strong>()</code> +<div class="block">Return the function to be called if the database environment panics.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>java.io.File[]</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionDirs()">getPartitionDirs</a></strong>()</code> +<div class="block">Return the array of directories the database extents should be created in or +looked for.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionHandler()">getPartitionHandler</a></strong>()</code> +<div class="block">Return the function to be called to determine which partition a key resides in.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionKeys()">getPartitionKeys</a></strong>()</code> +<div class="block">Return the array of keys the database is configured to partition with.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPartitionParts()">getPartitionParts</a></strong>()</code> +<div class="block">Return the number of partitions the database is configured for.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getPriority()">getPriority</a></strong>()</code> +<div class="block">Return the the cache priority for pages referenced by this handle.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getQueueExtentSize()">getQueueExtentSize</a></strong>()</code> +<div class="block">Return the size of the extents used to hold pages in a Queue database, + specified as a number of pages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getQueueInOrder()">getQueueInOrder</a></strong>()</code> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> method is configured to return key/data pairs in order, always returning the key/data item from the - head of the queue.</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/DatabaseConfig.html#getReadOnly()">getReadOnly</A></B>()</CODE> - -<BR> - Return true if the database is configured in read-only mode.</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/DatabaseConfig.html#getReadUncommitted()">getReadUncommitted</A></B>()</CODE> - -<BR> - Return true if the database is configured to support read uncommitted.</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/DatabaseConfig.html#getRecordDelimiter()">getRecordDelimiter</A></B>()</CODE> - -<BR> - Return the delimiting byte used to mark the end of a record in the - backing source file for the Recno access method.</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/DatabaseConfig.html#getRecordLength()">getRecordLength</A></B>()</CODE> - -<BR> - Return the database record length, in bytes.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordNumberAppender()">getRecordNumberAppender</A></B>()</CODE> - -<BR> - Return the function to call after the record number has been - selected but before the data has been stored into the database.</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/DatabaseConfig.html#getRecordPad()">getRecordPad</A></B>()</CODE> - -<BR> - Return the padding character for short, fixed-length records for the - Queue and Recno access methods.</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/io/File.html?is-external=true" title="class or interface in java.io">File</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getRecordSource()">getRecordSource</A></B>()</CODE> - -<BR> - Return the name of an underlying flat text database file that is - read to initialize a transient record number index.</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/DatabaseConfig.html#getRenumbering()">getRenumbering</A></B>()</CODE> - -<BR> - Return true if the logical record numbers are mutable, and change as - records are added to and deleted from the database.</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/DatabaseConfig.html#getReverseSplitOff()">getReverseSplitOff</A></B>()</CODE> - -<BR> - Return true if the Btree has been configured to not do reverse splits.</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/DatabaseConfig.html#getSnapshot()">getSnapshot</A></B>()</CODE> - -<BR> - Return true if the any specified backing source file will be read in its - entirety when the database is opened.</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/DatabaseConfig.html#getSortedDuplicates()">getSortedDuplicates</A></B>()</CODE> - -<BR> - Return true if the database is configured to support sorted duplicate data - items.</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/DatabaseConfig.html#getTransactional()">getTransactional</A></B>()</CODE> - -<BR> - Return true if the database open is enclosed within a transaction.</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/DatabaseConfig.html#getTransactionNotDurable()">getTransactionNotDurable</A></B>()</CODE> - -<BR> - Return true if the database environment is configured to not write log - records for this database.</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/DatabaseConfig.html#getTruncate()">getTruncate</A></B>()</CODE> - -<BR> - Return true if the database has been configured to be physically truncated + head of the queue.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadOnly()">getReadOnly</a></strong>()</code> +<div class="block">Return true if the database is configured in read-only mode.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()">getReadUncommitted</a></strong>()</code> +<div class="block">Return true if the database is configured to support read uncommitted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordDelimiter()">getRecordDelimiter</a></strong>()</code> +<div class="block">Return the delimiting byte used to mark the end of a record in the + backing source file for the Recno access method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordLength()">getRecordLength</a></strong>()</code> +<div class="block">Return the database record length, in bytes.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordNumberAppender()">getRecordNumberAppender</a></strong>()</code> +<div class="block">Return the function to call after the record number has been + selected but before the data has been stored into the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordPad()">getRecordPad</a></strong>()</code> +<div class="block">Return the padding character for short, fixed-length records for the + Queue and Recno access methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>java.io.File</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRecordSource()">getRecordSource</a></strong>()</code> +<div class="block">Return the name of an underlying flat text database file that is + read to initialize a transient record number index.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getRenumbering()">getRenumbering</a></strong>()</code> +<div class="block">Return true if the logical record numbers are mutable, and change as + records are added to and deleted from the database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getReverseSplitOff()">getReverseSplitOff</a></strong>()</code> +<div class="block">Return true if the Btree has been configured to not do reverse splits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getSnapshot()">getSnapshot</a></strong>()</code> +<div class="block">Return true if the any specified backing source file will be read in its + entirety when the database is opened.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getSortedDuplicates()">getSortedDuplicates</a></strong>()</code> +<div class="block">Return true if the database is configured to support sorted duplicate data + items.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getTransactional()">getTransactional</a></strong>()</code> +<div class="block">Return true if the database open is enclosed within a transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getTransactionNotDurable()">getTransactionNotDurable</a></strong>()</code> +<div class="block">Return true if the database environment is configured to not write log + records for this database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getTruncate()">getTruncate</a></strong>()</code> +<div class="block">Return true if the database has been configured to be physically truncated by truncating the underlying file, discarding all previous databases - it might have held.</TD> -</TR> -<TR BGCOLOR="white" CLASS="TableRowColor"> -<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> -<CODE> <A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getType()">getType</A></B>()</CODE> - -<BR> - Return the type of the database.</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/DatabaseConfig.html#getUnsortedDuplicates()">getUnsortedDuplicates</A></B>()</CODE> - -<BR> - Return true if the database is configured to support duplicate data items.</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/DatabaseConfig.html#setAllowCreate(boolean)">setAllowCreate</A></B>(boolean allowCreate)</CODE> - -<BR> - Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to create - the database if it does not already exist.</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/DatabaseConfig.html#setBtreeComparator(java.util.Comparator)">setBtreeComparator</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> btreeComparator)</CODE> - -<BR> - By default, a byte by byte lexicographic comparison is used for - btree keys.</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/DatabaseConfig.html#setBtreeCompressor(com.sleepycat.db.BtreeCompressor)">setBtreeCompressor</A></B>(<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> btreeCompressor)</CODE> - -<BR> - Set the Btree compression callbacks.</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/DatabaseConfig.html#setBtreeMinKey(int)">setBtreeMinKey</A></B>(int btMinKey)</CODE> - -<BR> - Set the minimum number of key/data pairs intended to be stored on any - single Btree leaf page.</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/DatabaseConfig.html#setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)">setBtreePrefixCalculator</A></B>(<A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> btreePrefixCalculator)</CODE> - -<BR> - Set the Btree prefix callback.</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/DatabaseConfig.html#setBtreeRecordNumbers(boolean)">setBtreeRecordNumbers</A></B>(boolean btreeRecordNumbers)</CODE> - -<BR> - Configure the Btree to support retrieval by 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/DatabaseConfig.html#setByteOrder(int)">setByteOrder</A></B>(int byteOrder)</CODE> - -<BR> - Set the byte order for integers in the stored database metadata.</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/DatabaseConfig.html#setCacheCount(int)">setCacheCount</A></B>(int cacheCount)</CODE> - -<BR> - Set the number of shared memory buffer pools, that is, the number of -caches.</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/DatabaseConfig.html#setCacheSize(long)">setCacheSize</A></B>(long cacheSize)</CODE> - -<BR> - Set the size of the shared memory buffer pool, that is, the size of the -cache.</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/DatabaseConfig.html#setChecksum(boolean)">setChecksum</A></B>(boolean checksum)</CODE> - -<BR> - Configure the database environment to do checksum verification of - pages read into the cache from the backing filestore.</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/DatabaseConfig.html#setCreateDir(java.io.File)">setCreateDir</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> createDir)</CODE> - -<BR> - Specify which directory a database should be created in or looked for.</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/DatabaseConfig.html#setDirtyRead(boolean)">setDirtyRead</A></B>(boolean dirtyRead)</CODE> - -<BR> - <B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><CODE>setReadUncommitted(boolean)</CODE></A> to conform to ANSI - database isolation terminology.</I></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/DatabaseConfig.html#setDuplicateComparator(java.util.Comparator)">setDuplicateComparator</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> duplicateComparator)</CODE> - -<BR> - Set the duplicate data item comparison callback.</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/DatabaseConfig.html#setEncrypted(java.lang.String)">setEncrypted</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</CODE> - -<BR> - Set the password used to perform encryption and decryption.</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/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)">setErrorHandler</A></B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</CODE> - -<BR> - Set the function to be called if an error occurs.</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/DatabaseConfig.html#setErrorPrefix(java.lang.String)">setErrorPrefix</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorPrefix)</CODE> - -<BR> - Set the prefix string that appears before error messages.</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/DatabaseConfig.html#setErrorStream(java.io.OutputStream)">setErrorStream</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> errorStream)</CODE> - -<BR> - Set an OutputStream for displaying error messages.</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/DatabaseConfig.html#setExclusiveCreate(boolean)">setExclusiveCreate</A></B>(boolean exclusiveCreate)</CODE> - -<BR> - Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to fail if - the database already exists.</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/DatabaseConfig.html#setFeedbackHandler(com.sleepycat.db.FeedbackHandler)">setFeedbackHandler</A></B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</CODE> - -<BR> - Set an object whose methods are called to provide feedback.</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/DatabaseConfig.html#setHashComparator(java.util.Comparator)">setHashComparator</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> hashComparator)</CODE> - -<BR> - Set the Hash key comparison function.</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/DatabaseConfig.html#setHasher(com.sleepycat.db.Hasher)">setHasher</A></B>(<A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> hasher)</CODE> - -<BR> - Set a database-specific hash function.</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/DatabaseConfig.html#setHashFillFactor(int)">setHashFillFactor</A></B>(int hashFillFactor)</CODE> - -<BR> - Set the desired density within the hash table.</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/DatabaseConfig.html#setHashNumElements(int)">setHashNumElements</A></B>(int hashNumElements)</CODE> - -<BR> - Set an estimate of the final size of the hash table.</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/DatabaseConfig.html#setHeapRegionSize(int)">setHeapRegionSize</A></B>(int npages)</CODE> - -<BR> - Sets the number of pages in a region of a database configured to use - the Heap access method.</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/DatabaseConfig.html#setHeapsize(long)">setHeapsize</A></B>(long bytes)</CODE> - -<BR> - Set the maximum on-disk database file size used by a database configured to - use the Heap access method.</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/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)">setMessageHandler</A></B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</CODE> - -<BR> - Set a function to be called with an informational message.</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/DatabaseConfig.html#setMessageStream(java.io.OutputStream)">setMessageStream</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> messageStream)</CODE> - -<BR> - Set an OutputStream for displaying informational messages.</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/DatabaseConfig.html#setMode(int)">setMode</A></B>(int mode)</CODE> - -<BR> - On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files + it might have held.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getType()">getType</a></strong>()</code> +<div class="block">Return the type of the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#getUnsortedDuplicates()">getUnsortedDuplicates</a></strong>()</code> +<div class="block">Return true if the database is configured to support duplicate data items.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setAllowCreate(boolean)">setAllowCreate</a></strong>(boolean allowCreate)</code> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to create + the database if it does not already exist.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBlobDir(java.io.File)">setBlobDir</a></strong>(java.io.File dir)</code> +<div class="block">Sets the path of a directory where blobs are stored.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBlobThreshold(int)">setBlobThreshold</a></strong>(int value)</code> +<div class="block">Set the size in bytes which is used to determine when a data item will be + stored as a blob.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeComparator(java.util.Comparator)">setBtreeComparator</a></strong>(java.util.Comparator btreeComparator)</code> +<div class="block">By default, a byte by byte lexicographic comparison is used for + btree keys.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeCompressor(com.sleepycat.db.BtreeCompressor)">setBtreeCompressor</a></strong>(<a href="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a> btreeCompressor)</code> +<div class="block">Set the Btree compression callbacks.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeMinKey(int)">setBtreeMinKey</a></strong>(int btMinKey)</code> +<div class="block">Set the minimum number of key/data pairs intended to be stored on any + single Btree leaf page.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)">setBtreePrefixCalculator</a></strong>(<a href="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a> btreePrefixCalculator)</code> +<div class="block">Set the Btree prefix callback.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setBtreeRecordNumbers(boolean)">setBtreeRecordNumbers</a></strong>(boolean btreeRecordNumbers)</code> +<div class="block">Configure the Btree to support retrieval by record number.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setByteOrder(int)">setByteOrder</a></strong>(int byteOrder)</code> +<div class="block">Set the byte order for integers in the stored database metadata.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setCacheCount(int)">setCacheCount</a></strong>(int cacheCount)</code> +<div class="block">Set the number of shared memory buffer pools, that is, the number of +caches.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setCacheSize(long)">setCacheSize</a></strong>(long cacheSize)</code> +<div class="block">Set the size of the shared memory buffer pool, that is, the size of the +cache.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setChecksum(boolean)">setChecksum</a></strong>(boolean checksum)</code> +<div class="block">Configure the database environment to do checksum verification of + pages read into the cache from the backing filestore.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setCreateDir(java.io.File)">setCreateDir</a></strong>(java.io.File createDir)</code> +<div class="block">Specify which directory a database should be created in or looked for.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setDirtyRead(boolean)">setDirtyRead</a></strong>(boolean dirtyRead)</code> +<div class="block"><strong>Deprecated.</strong> +<div class="block"><i>This has been replaced by <a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><code>setReadUncommitted(boolean)</code></a> to conform to ANSI + database isolation terminology.</i></div> +</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setDuplicateComparator(java.util.Comparator)">setDuplicateComparator</a></strong>(java.util.Comparator duplicateComparator)</code> +<div class="block">Set the duplicate data item comparison callback.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setEncrypted(java.lang.String)">setEncrypted</a></strong>(java.lang.String password)</code> +<div class="block">Set the password used to perform encryption and decryption.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)">setErrorHandler</a></strong>(<a href="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> errorHandler)</code> +<div class="block">Set the function to be called if an error occurs.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)">setErrorPrefix</a></strong>(java.lang.String errorPrefix)</code> +<div class="block">Set the prefix string that appears before error messages.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)">setErrorStream</a></strong>(java.io.OutputStream errorStream)</code> +<div class="block">Set an OutputStream for displaying error messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setExclusiveCreate(boolean)">setExclusiveCreate</a></strong>(boolean exclusiveCreate)</code> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to fail if + the database already exists.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setFeedbackHandler(com.sleepycat.db.FeedbackHandler)">setFeedbackHandler</a></strong>(<a href="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> feedbackHandler)</code> +<div class="block">Set an object whose methods are called to provide feedback.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashComparator(java.util.Comparator)">setHashComparator</a></strong>(java.util.Comparator hashComparator)</code> +<div class="block">Set the Hash key comparison function.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHasher(com.sleepycat.db.Hasher)">setHasher</a></strong>(<a href="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</a> hasher)</code> +<div class="block">Set a database-specific hash function.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)">setHashFillFactor</a></strong>(int hashFillFactor)</code> +<div class="block">Set the desired density within the hash table.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashNumElements(int)">setHashNumElements</a></strong>(int hashNumElements)</code> +<div class="block">Set an estimate of the final size of the hash table.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHeapRegionSize(int)">setHeapRegionSize</a></strong>(int npages)</code> +<div class="block">Sets the number of pages in a region of a database configured to use + the Heap access method.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setHeapsize(long)">setHeapsize</a></strong>(long bytes)</code> +<div class="block">Set the maximum on-disk database file size used by a database configured to + use the Heap access method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)">setMessageHandler</a></strong>(<a href="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> messageHandler)</code> +<div class="block">Set a function to be called with an informational message.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)">setMessageStream</a></strong>(java.io.OutputStream messageStream)</code> +<div class="block">Set an OutputStream for displaying informational messages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setMode(int)">setMode</a></strong>(int mode)</code> +<div class="block">On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files created by the database open are created with mode <code>mode</code> (as described in the <code>chmod</code>(2) manual page) and modified by the process' umask value at the time of creation (see the - <code>umask</code>(2) manual page).</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/DatabaseConfig.html#setMultiversion(boolean)">setMultiversion</A></B>(boolean multiversion)</CODE> - -<BR> - Configured the database with support for multiversion concurrency control.</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/DatabaseConfig.html#setNoMMap(boolean)">setNoMMap</A></B>(boolean noMMap)</CODE> - -<BR> - Configure the library to not map this database into memory.</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/DatabaseConfig.html#setNoWaitDbExclusiveLock(java.lang.Boolean)">setNoWaitDbExclusiveLock</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> noWaitDbExclLock)</CODE> - -<BR> - Configure the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle to obtain a -write lock on the entire database.</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/DatabaseConfig.html#setPageSize(int)">setPageSize</A></B>(int pageSize)</CODE> - -<BR> - Set the size of the pages used to hold items in the database, 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/DatabaseConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)">setPanicHandler</A></B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</CODE> - -<BR> - Set the function to be called if the database environment panics.</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/DatabaseConfig.html#setPartitionByCallback(int, com.sleepycat.db.PartitionHandler)">setPartitionByCallback</A></B>(int parts, - <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> partitionHandler)</CODE> - -<BR> - Enable or disable database partitioning, and set the callback that will -be used for the partitioning.</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/DatabaseConfig.html#setPartitionByRange(int, com.sleepycat.db.MultipleDataEntry)">setPartitionByRange</A></B>(int parts, - <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</A> keys)</CODE> - -<BR> - Enable or disable database partitioning, and set key ranges that will be - used for the partitioning.</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/DatabaseConfig.html#setPartitionDirs(java.io.File[])">setPartitionDirs</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] dirs)</CODE> - -<BR> - Specify the array of directories the database extents should be created in or -looked for.</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/DatabaseConfig.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</A></B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> priority)</CODE> - -<BR> - Set the cache priority for pages referenced by the DB handle.</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/DatabaseConfig.html#setQueueExtentSize(int)">setQueueExtentSize</A></B>(int queueExtentSize)</CODE> - -<BR> - Set the size of the extents used to hold pages in a Queue database, - specified as a number of pages.</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/DatabaseConfig.html#setQueueInOrder(boolean)">setQueueInOrder</A></B>(boolean queueInOrder)</CODE> - -<BR> - Configure <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> to return key/data pairs in + <code>umask</code>(2) manual page).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setMsgfile(java.io.File)">setMsgfile</a></strong>(java.io.File file)</code> +<div class="block">Sets the path of a file to store statistical information.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setMultiversion(boolean)">setMultiversion</a></strong>(boolean multiversion)</code> +<div class="block">Configured the database with support for multiversion concurrency control.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setNoMMap(boolean)">setNoMMap</a></strong>(boolean noMMap)</code> +<div class="block">Configure the library to not map this database into memory.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setNoWaitDbExclusiveLock(java.lang.Boolean)">setNoWaitDbExclusiveLock</a></strong>(java.lang.Boolean noWaitDbExclLock)</code> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a +write lock on the entire database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)">setPageSize</a></strong>(int pageSize)</code> +<div class="block">Set the size of the pages used to hold items in the database, 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/DatabaseConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)">setPanicHandler</a></strong>(<a href="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> panicHandler)</code> +<div class="block">Set the function to be called if the database environment panics.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByCallback(int,%20com.sleepycat.db.PartitionHandler)">setPartitionByCallback</a></strong>(int parts, + <a href="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a> partitionHandler)</code> +<div class="block">Enable or disable database partitioning, and set the callback that will +be used for the partitioning.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionByRange(int,%20com.sleepycat.db.MultipleDataEntry)">setPartitionByRange</a></strong>(int parts, + <a href="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</a> keys)</code> +<div class="block">Enable or disable database partitioning, and set key ranges that will be + used for the partitioning.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setPartitionDirs(java.io.File[])">setPartitionDirs</a></strong>(java.io.File[] dirs)</code> +<div class="block">Specify the array of directories the database extents should be created in or +looked for.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setPriority(com.sleepycat.db.CacheFilePriority)">setPriority</a></strong>(<a href="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> priority)</code> +<div class="block">Set the cache priority for pages referenced by the DB handle.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setQueueExtentSize(int)">setQueueExtentSize</a></strong>(int queueExtentSize)</code> +<div class="block">Set the size of the extents used to hold pages in a Queue database, + specified as a number of pages.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setQueueInOrder(boolean)">setQueueInOrder</a></strong>(boolean queueInOrder)</code> +<div class="block">Configure <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> to return key/data pairs in order, always returning the key/data item from the head of the - queue.</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/DatabaseConfig.html#setReadOnly(boolean)">setReadOnly</A></B>(boolean readOnly)</CODE> - -<BR> - Configure the database in read-only mode.</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/DatabaseConfig.html#setReadUncommitted(boolean)">setReadUncommitted</A></B>(boolean readUncommitted)</CODE> - -<BR> - Configure the database to support read uncommitted.</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/DatabaseConfig.html#setRecordDelimiter(int)">setRecordDelimiter</A></B>(int recordDelimiter)</CODE> - -<BR> - Set the delimiting byte used to mark the end of a record in the backing - source file for the Recno access method.</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/DatabaseConfig.html#setRecordLength(int)">setRecordLength</A></B>(int recordLength)</CODE> - -<BR> - Specify the database record length, 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/DatabaseConfig.html#setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)">setRecordNumberAppender</A></B>(<A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> recnoAppender)</CODE> - -<BR> - Configure <A HREF="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>Database.append</CODE></A> to call the function after the + queue.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadOnly(boolean)">setReadOnly</a></strong>(boolean readOnly)</code> +<div class="block">Configure the database in read-only mode.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)">setReadUncommitted</a></strong>(boolean readUncommitted)</code> +<div class="block">Configure the database to support read uncommitted.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)">setRecordDelimiter</a></strong>(int recordDelimiter)</code> +<div class="block">Set the delimiting byte used to mark the end of a record in the backing + source file for the Recno access method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordLength(int)">setRecordLength</a></strong>(int recordLength)</code> +<div class="block">Specify the database record length, 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/DatabaseConfig.html#setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)">setRecordNumberAppender</a></strong>(<a href="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a> recnoAppender)</code> +<div class="block">Configure <a href="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)"><code>Database.append</code></a> to call the function after the record number has been selected but before the data has been stored - into the database.</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/DatabaseConfig.html#setRecordPad(int)">setRecordPad</A></B>(int recordPad)</CODE> - -<BR> - Set the padding character for short, fixed-length records for the Queue - and Recno access methods.</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/DatabaseConfig.html#setRecordSource(java.io.File)">setRecordSource</A></B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> recordSource)</CODE> - -<BR> - Set the underlying source file for the Recno access method.</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/DatabaseConfig.html#setRenumbering(boolean)">setRenumbering</A></B>(boolean renumbering)</CODE> - -<BR> - Configure the logical record numbers to be mutable, and change as - records are added to and deleted from the database.</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/DatabaseConfig.html#setReverseSplitOff(boolean)">setReverseSplitOff</A></B>(boolean reverseSplitOff)</CODE> - -<BR> - Configure the Btree to not do reverse splits.</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/DatabaseConfig.html#setSnapshot(boolean)">setSnapshot</A></B>(boolean snapshot)</CODE> - -<BR> - Specify that any specified backing source file be read in its entirety - when the database is opened.</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/DatabaseConfig.html#setSortedDuplicates(boolean)">setSortedDuplicates</A></B>(boolean sortedDuplicates)</CODE> - -<BR> - Configure the database to support sorted, duplicate data items.</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/DatabaseConfig.html#setTransactional(boolean)">setTransactional</A></B>(boolean transactional)</CODE> - -<BR> - Enclose the database open within a transaction.</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/DatabaseConfig.html#setTransactionNotDurable(boolean)">setTransactionNotDurable</A></B>(boolean transactionNotDurable)</CODE> - -<BR> - Configure the database environment to not write log records for this - database.</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/DatabaseConfig.html#setTruncate(boolean)">setTruncate</A></B>(boolean truncate)</CODE> - -<BR> - Configure the database to be physically truncated by truncating the + into the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)">setRecordPad</a></strong>(int recordPad)</code> +<div class="block">Set the padding character for short, fixed-length records for the Queue + and Recno access methods.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordSource(java.io.File)">setRecordSource</a></strong>(java.io.File recordSource)</code> +<div class="block">Set the underlying source file for the Recno access method.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setRenumbering(boolean)">setRenumbering</a></strong>(boolean renumbering)</code> +<div class="block">Configure the logical record numbers to be mutable, and change as + records are added to and deleted from the database.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setReverseSplitOff(boolean)">setReverseSplitOff</a></strong>(boolean reverseSplitOff)</code> +<div class="block">Configure the Btree to not do reverse splits.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)">setSnapshot</a></strong>(boolean snapshot)</code> +<div class="block">Specify that any specified backing source file be read in its entirety + when the database is opened.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)">setSortedDuplicates</a></strong>(boolean sortedDuplicates)</code> +<div class="block">Configure the database to support sorted, duplicate data items.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactional(boolean)">setTransactional</a></strong>(boolean transactional)</code> +<div class="block">Enclose the database open within a transaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setTransactionNotDurable(boolean)">setTransactionNotDurable</a></strong>(boolean transactionNotDurable)</code> +<div class="block">Configure the database environment to not write log records for this + database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setTruncate(boolean)">setTruncate</a></strong>(boolean truncate)</code> +<div class="block">Configure the database to be physically truncated by truncating the underlying file, discarding all previous databases it might have - held.</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/DatabaseConfig.html#setType(com.sleepycat.db.DatabaseType)">setType</A></B>(<A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> type)</CODE> - -<BR> - Configure the type of the database.</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/DatabaseConfig.html#setUnsortedDuplicates(boolean)">setUnsortedDuplicates</A></B>(boolean unsortedDuplicates)</CODE> - -<BR> - Configure the database to support unsorted duplicate data items.</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#equals(java.lang.Object)" title="class or interface in java.lang">equals</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#hashCode()" title="class or interface in java.lang">hashCode</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> - + held.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setType(com.sleepycat.db.DatabaseType)">setType</a></strong>(<a href="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a> type)</code> +<div class="block">Configure the type of the database.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/DatabaseConfig.html#setUnsortedDuplicates(boolean)">setUnsortedDuplicates</a></strong>(boolean unsortedDuplicates)</code> +<div class="block">Configure the database to support unsorted duplicate data items.</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"> <!-- ============ FIELD DETAIL =========== --> - -<A NAME="field_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>Field Detail</B></FONT></TH> -</TR> -</TABLE> - -<A NAME="DEFAULT"><!-- --></A><H3> -DEFAULT</H3> -<PRE> -public static final <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> <B>DEFAULT</B></PRE> -<DL> -<DD>An instance created using the default constructor is initialized - with the system's default settings. -<P> -<DL> -</DL> -</DL> - +<ul class="blockList"> +<li class="blockList"><a name="field_detail"> +<!-- --> +</a> +<h3>Field Detail</h3> +<a name="DEFAULT"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DEFAULT</h4> +<pre>public static final <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> DEFAULT</pre> +<div class="block">An instance created using the default constructor is initialized + with the system's default settings.</div> +</li> +</ul> +</li> +</ul> <!-- ========= 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="DatabaseConfig()"><!-- --></A><H3> -DatabaseConfig</H3> -<PRE> -public <B>DatabaseConfig</B>()</PRE> -<DL> -<DD>An instance created using the default constructor is initialized with - the system's default settings. -<P> -</DL> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="DatabaseConfig()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>DatabaseConfig</h4> +<pre>public DatabaseConfig()</pre> +<div class="block">An instance created using the default constructor is initialized with + the system's default settings.</div> +</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="cloneConfig()"><!-- --></A><H3> -cloneConfig</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</A> <B>cloneConfig</B>()</PRE> -<DL> -<DD>Returns a copy of this configuration object. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setAllowCreate(boolean)"><!-- --></A><H3> -setAllowCreate</H3> -<PRE> -public void <B>setAllowCreate</B>(boolean allowCreate)</PRE> -<DL> -<DD>Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to create +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="cloneConfig()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>cloneConfig</h4> +<pre>public <a href="../../../com/sleepycat/db/DatabaseConfig.html" title="class in com.sleepycat.db">DatabaseConfig</a> cloneConfig()</pre> +<div class="block">Returns a copy of this configuration object.</div> +</li> +</ul> +<a name="setAllowCreate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAllowCreate</h4> +<pre>public void setAllowCreate(boolean allowCreate)</pre> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to create the database if it does not already exist. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>allowCreate</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to - create the database if it does not already exist.</DL> -</DD> -</DL> -<HR> - -<A NAME="getAllowCreate()"><!-- --></A><H3> -getAllowCreate</H3> -<PRE> -public boolean <B>getAllowCreate</B>()</PRE> -<DL> -<DD>Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>allowCreate</code> - If true, configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to + create the database if it does not already exist.</dd></dl> +</li> +</ul> +<a name="getAllowCreate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getAllowCreate</h4> +<pre>public boolean getAllowCreate()</pre> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured to create the database if it does not already exist. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured - to create the database if it does not already exist.</DL> -</DD> -</DL> -<HR> - -<A NAME="setBtreeComparator(java.util.Comparator)"><!-- --></A><H3> -setBtreeComparator</H3> -<PRE> -public void <B>setBtreeComparator</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> btreeComparator)</PRE> -<DL> -<DD>By default, a byte by byte lexicographic comparison is used for +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured + to create the database if it does not already exist.</dd></dl> +</li> +</ul> +<a name="setBlobDir(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobDir</h4> +<pre>public void setBlobDir(java.io.File dir)</pre> +<div class="block">Sets the path of a directory where blobs are stored. + <p> + If the database is opened within an environment, this path setting is + ignored in + <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a>. + Use <a href="../../../com/sleepycat/db/Database.html#getConfig()"><code>Database.getConfig</code></a> and + <a href="../../../com/sleepycat/db/DatabaseConfig.html#getBlobDir()"><code>DatabaseConfig.getBlobDir</code></a> + to identify the current storage location of blobs after opening + the database. + <p> + This path can not be set after opening the database. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dir</code> - The path of a directory where blobs are stored.</dd></dl> +</li> +</ul> +<a name="getBlobDir()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlobDir</h4> +<pre>public java.io.File getBlobDir()</pre> +<div class="block">Returns the path of a directory where blobs are stored. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The path of a directory where blobs are stored.</dd></dl> +</li> +</ul> +<a name="setBlobThreshold(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBlobThreshold</h4> +<pre>public void setBlobThreshold(int value)</pre> +<div class="block">Set the size in bytes which is used to determine when a data item will be + stored as a blob. + <p> + Any data item that is equal to or larger in size than the + threshold value will automatically be stored as a blob. + <p> + It is illegal to enable blob in the database which is configured + as in-memory database or with chksum, encryption, duplicates, sorted + duplicates, compression, multiversion concurrency control and + transactional read operations with degree 1 isolation. + <p> + This threshold value can not be set after opening the database. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - The size in bytes which is used to determine when a data item will be + stored as a blob. If 0, blob will be never used by the database.</dd></dl> +</li> +</ul> +<a name="getBlobThreshold()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBlobThreshold</h4> +<pre>public int getBlobThreshold()</pre> +<div class="block">Return the threshold value in bytes beyond which data items are + stored as blobs. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The threshold value in bytes beyond which data items are + stored as blobs. If 0, blob is not used by the database.</dd></dl> +</li> +</ul> +<a name="setBtreeComparator(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBtreeComparator</h4> +<pre>public void setBtreeComparator(java.util.Comparator btreeComparator)</pre> +<div class="block">By default, a byte by byte lexicographic comparison is used for btree keys. To customize the comparison, supply a different Comparator. <p> @@ -1255,42 +1128,30 @@ public void <B>setBtreeComparator</B>(<A HREF="http://download.oracle.com/javase keys that are stored in the database. If you know how your data is organized in the byte array, then you can write a comparison routine that directly examines the contents of the arrays. Otherwise, you have to - reconstruct your original objects, and then perform the comparison. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getBtreeComparator()"><!-- --></A><H3> -getBtreeComparator</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getBtreeComparator</B>()</PRE> -<DL> -<DD>Return the custom Comparator used for btree keys. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the custom Comparator used for btree keys, or null if the default - comparison function will be used.</DL> -</DD> -</DL> -<HR> - -<A NAME="setBtreeMinKey(int)"><!-- --></A><H3> -setBtreeMinKey</H3> -<PRE> -public void <B>setBtreeMinKey</B>(int btMinKey)</PRE> -<DL> -<DD>Set the minimum number of key/data pairs intended to be stored on any + reconstruct your original objects, and then perform the comparison.</div> +</li> +</ul> +<a name="getBtreeComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBtreeComparator</h4> +<pre>public java.util.Comparator getBtreeComparator()</pre> +<div class="block">Return the custom Comparator used for btree keys. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the custom Comparator used for btree keys, or null if the default + comparison function will be used.</dd></dl> +</li> +</ul> +<a name="setBtreeMinKey(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBtreeMinKey</h4> +<pre>public void setBtreeMinKey(int btMinKey)</pre> +<div class="block">Set the minimum number of key/data pairs intended to be stored on any single Btree leaf page. <p> This value is used to determine if key or data items will be stored @@ -1298,51 +1159,40 @@ public void <B>setBtreeMinKey</B>(int btMinKey)</PRE> at least 2; if the value is not explicitly set, a value of 2 is used. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>btMinKey</CODE> - The minimum number of key/data pairs intended to be stored on any - single Btree leaf page.</DL> -</DD> -</DL> -<HR> - -<A NAME="getBtreeMinKey()"><!-- --></A><H3> -getBtreeMinKey</H3> -<PRE> -public int <B>getBtreeMinKey</B>()</PRE> -<DL> -<DD>Return the minimum number of key/data pairs intended to be stored + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>btMinKey</code> - The minimum number of key/data pairs intended to be stored on any + single Btree leaf page.</dd></dl> +</li> +</ul> +<a name="getBtreeMinKey()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBtreeMinKey</h4> +<pre>public int getBtreeMinKey()</pre> +<div class="block">Return the minimum number of key/data pairs intended to be stored on any single Btree leaf page. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The minimum number of key/data pairs intended to be stored - on any single Btree leaf page.</DL> -</DD> -</DL> -<HR> - -<A NAME="setByteOrder(int)"><!-- --></A><H3> -setByteOrder</H3> -<PRE> -public void <B>setByteOrder</B>(int byteOrder)</PRE> -<DL> -<DD>Set the byte order for integers in the stored database metadata. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The minimum number of key/data pairs intended to be stored + on any single Btree leaf page.</dd></dl> +</li> +</ul> +<a name="setByteOrder(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setByteOrder</h4> +<pre>public void setByteOrder(int byteOrder)</pre> +<div class="block">Set the byte order for integers in the stored database metadata. <p> The host byte order of the machine where the process is running will be used if no byte order is set. @@ -1354,7 +1204,7 @@ public void <B>setByteOrder</B>(int byteOrder)</PRE> </b> <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, @@ -1362,48 +1212,37 @@ the information specified to this method will be ignored. If creating additional databases in a single physical file, information specified to this method will be ignored and the byte order of the existing databases will be used. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>byteOrder</CODE> - The byte order as an integer; for example, big endian order is the - number 4,321, and little endian order is the number 1,234.</DL> -</DD> -</DL> -<HR> - -<A NAME="getByteOrder()"><!-- --></A><H3> -getByteOrder</H3> -<PRE> -public int <B>getByteOrder</B>()</PRE> -<DL> -<DD>Return the database byte order; a byte order of 4,321 indicates a + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>byteOrder</code> - The byte order as an integer; for example, big endian order is the + number 4,321, and little endian order is the number 1,234.</dd></dl> +</li> +</ul> +<a name="getByteOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getByteOrder</h4> +<pre>public int getByteOrder()</pre> +<div class="block">Return the database byte order; a byte order of 4,321 indicates a big endian order, and a byte order of 1,234 indicates a little endian order. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The database byte order; a byte order of 4,321 indicates a +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The database byte order; a byte order of 4,321 indicates a big endian order, and a byte order of 1,234 indicates a little - endian order.</DL> -</DD> -</DL> -<HR> - -<A NAME="getByteSwapped()"><!-- --></A><H3> -getByteSwapped</H3> -<PRE> -public boolean <B>getByteSwapped</B>()</PRE> -<DL> -<DD>Return if the underlying database files were created on an architecture + endian order.</dd></dl> +</li> +</ul> +<a name="getByteSwapped()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getByteSwapped</h4> +<pre>public boolean getByteSwapped()</pre> +<div class="block">Return if the underlying database files were created on an architecture of the same byte order as the current one. <p> This information may be used to determine whether application data @@ -1411,59 +1250,41 @@ public boolean <B>getByteSwapped</B>()</PRE> <p> This method may not be called before the database has been opened. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>Return false if the underlying database files were created on an + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>Return false if the underlying database files were created on an architecture of the same byte order as the current one, and true if they were not (that is, big-endian on a little-endian machine, or - vice versa).</DL> -</DD> -</DL> -<HR> - -<A NAME="setBtreeCompressor(com.sleepycat.db.BtreeCompressor)"><!-- --></A><H3> -setBtreeCompressor</H3> -<PRE> -public void <B>setBtreeCompressor</B>(<A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> btreeCompressor)</PRE> -<DL> -<DD>Set the Btree compression callbacks. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getBtreeCompressor()"><!-- --></A><H3> -getBtreeCompressor</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</A> <B>getBtreeCompressor</B>()</PRE> -<DL> -<DD>Get the Btree compression callbacks. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)"><!-- --></A><H3> -setBtreePrefixCalculator</H3> -<PRE> -public void <B>setBtreePrefixCalculator</B>(<A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> btreePrefixCalculator)</PRE> -<DL> -<DD>Set the Btree prefix callback. The prefix callback is used to determine + vice versa).</dd></dl> +</li> +</ul> +<a name="setBtreeCompressor(com.sleepycat.db.BtreeCompressor)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBtreeCompressor</h4> +<pre>public void setBtreeCompressor(<a href="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a> btreeCompressor)</pre> +<div class="block">Set the Btree compression callbacks.</div> +</li> +</ul> +<a name="getBtreeCompressor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBtreeCompressor</h4> +<pre>public <a href="../../../com/sleepycat/db/BtreeCompressor.html" title="interface in com.sleepycat.db">BtreeCompressor</a> getBtreeCompressor()</pre> +<div class="block">Get the Btree compression callbacks.</div> +</li> +</ul> +<a name="setBtreePrefixCalculator(com.sleepycat.db.BtreePrefixCalculator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBtreePrefixCalculator</h4> +<pre>public void setBtreePrefixCalculator(<a href="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a> btreePrefixCalculator)</pre> +<div class="block">Set the Btree prefix callback. The prefix callback is used to determine the amount by which keys stored on the Btree internal pages can be safely truncated without losing their uniqueness. See the <a href="../../../../programmer_reference/bt_conf.html#am_conf_bt_prefix" target="_top">Btree prefix @@ -1477,43 +1298,31 @@ public void <B>setBtreePrefixCalculator</B>(<A HREF="../../../com/sleepycat/db/B prefixes. If no prefix callback is specified and a key comparison callback is specified, no prefix function is used. It is an error to specify a prefix function without also specifying a Btree key comparison - function. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getBtreePrefixCalculator()"><!-- --></A><H3> -getBtreePrefixCalculator</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</A> <B>getBtreePrefixCalculator</B>()</PRE> -<DL> -<DD>Return the Btree prefix callback. + function.</div> +</li> +</ul> +<a name="getBtreePrefixCalculator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBtreePrefixCalculator</h4> +<pre>public <a href="../../../com/sleepycat/db/BtreePrefixCalculator.html" title="interface in com.sleepycat.db">BtreePrefixCalculator</a> getBtreePrefixCalculator()</pre> +<div class="block">Return the Btree prefix callback. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The Btree prefix callback.</DL> -</DD> -</DL> -<HR> - -<A NAME="setCacheSize(long)"><!-- --></A><H3> -setCacheSize</H3> -<PRE> -public void <B>setCacheSize</B>(long cacheSize)</PRE> -<DL> -<DD>Set the size of the shared memory buffer pool, that is, the size of the +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The Btree prefix callback.</dd></dl> +</li> +</ul> +<a name="setCacheSize(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheSize</h4> +<pre>public void setCacheSize(long cacheSize)</pre> +<div class="block">Set the size of the shared memory buffer pool, that is, the size of the cache. <p> The cache should be the size of the normal working data set of the @@ -1534,91 +1343,69 @@ cache size in a database created within an environment. This method may not be called after the database is opened. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>cacheSize</CODE> - The size of the shared memory buffer pool, that is, the size of the +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheSize</code> - The size of the shared memory buffer pool, that is, the size of the cache. <p> -<p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCacheSize()"><!-- --></A><H3> -getCacheSize</H3> -<PRE> -public long <B>getCacheSize</B>()</PRE> -<DL> -<DD>Return the size of the shared memory buffer pool, that is, the cache. +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getCacheSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheSize</h4> +<pre>public long getCacheSize()</pre> +<div class="block">Return the size of the shared memory buffer pool, that is, the cache. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The size of the shared memory buffer pool, that is, the cache.</DL> -</DD> -</DL> -<HR> - -<A NAME="setCreateDir(java.io.File)"><!-- --></A><H3> -setCreateDir</H3> -<PRE> -public void <B>setCreateDir</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> createDir)</PRE> -<DL> -<DD>Specify which directory a database should be created in or looked for. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>createDir</CODE> - The directory will be used to create or locate the database file specified in +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The size of the shared memory buffer pool, that is, the cache.</dd></dl> +</li> +</ul> +<a name="setCreateDir(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCreateDir</h4> +<pre>public void setCreateDir(java.io.File createDir)</pre> +<div class="block">Specify which directory a database should be created in or looked for. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>createDir</code> - The directory will be used to create or locate the database file specified in the openDatabase method call. The directory must be one of the directories in the environment list specified by EnvironmentConfig.addDataDirectory. <p> -<p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCreateDir()"><!-- --></A><H3> -getCreateDir</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getCreateDir</B>()</PRE> -<DL> -<DD>Return the directory a database will/has been created in or looked for. +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getCreateDir()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreateDir</h4> +<pre>public java.io.File getCreateDir()</pre> +<div class="block">Return the directory a database will/has been created in or looked for. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The directory a database will/has been created in or looked for.</DL> -</DD> -</DL> -<HR> - -<A NAME="setCacheCount(int)"><!-- --></A><H3> -setCacheCount</H3> -<PRE> -public void <B>setCacheCount</B>(int cacheCount)</PRE> -<DL> -<DD>Set the number of shared memory buffer pools, that is, the number of +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The directory a database will/has been created in or looked for.</dd></dl> +</li> +</ul> +<a name="setCacheCount(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCacheCount</h4> +<pre>public void setCacheCount(int cacheCount)</pre> +<div class="block">Set the number of shared memory buffer pools, that is, the number of caches. <p> It is possible to specify caches larger than 4GB and/or large enough @@ -1636,56 +1423,45 @@ multiple caches in a database created within an environment. This method may not be called after the database is opened. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>cacheCount</CODE> - The number of shared memory buffer pools, that is, the number of caches. -<p> -<p> -<DT><B>Throws:</B> -<DD><CODE><A HREF="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</A></CODE> - if a failure occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getCacheCount()"><!-- --></A><H3> -getCacheCount</H3> -<PRE> -public int <B>getCacheCount</B>()</PRE> -<DL> -<DD>Return the number of shared memory buffer pools, that is, the number +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>cacheCount</code> - The number of shared memory buffer pools, that is, the number of caches. +<p> +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="../../../com/sleepycat/db/DatabaseException.html" title="class in com.sleepycat.db">DatabaseException</a></code> - if a failure occurs.</dd></dl> +</li> +</ul> +<a name="getCacheCount()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCacheCount</h4> +<pre>public int getCacheCount()</pre> +<div class="block">Return the number of shared memory buffer pools, that is, the number of caches. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The number of shared memory buffer pools, that is, the number - of caches.</DL> -</DD> -</DL> -<HR> - -<A NAME="setChecksum(boolean)"><!-- --></A><H3> -setChecksum</H3> -<PRE> -public void <B>setChecksum</B>(boolean checksum)</PRE> -<DL> -<DD>Configure the database environment to do checksum verification of +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The number of shared memory buffer pools, that is, the number + of caches.</dd></dl> +</li> +</ul> +<a name="setChecksum(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setChecksum</h4> +<pre>public void setChecksum(boolean checksum)</pre> +<div class="block">Configure the database environment to do checksum verification of pages read into the cache from the backing filestore. <p> Berkeley DB uses the SHA1 Secure Hash Algorithm if encryption is also configured for this database, and a general hash algorithm if it is not. <p> - Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle + Calling this method only affects the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle (and any other library handles opened within the scope of that handle). <p> If the database already exists when the database is opened, any database @@ -1694,148 +1470,113 @@ will be ignored. If creating additional databases in a file, the checksum behavior specified must be consistent with the existing databases in the file or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>checksum</CODE> - If true, configure the database environment to do checksum verification + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>checksum</code> - If true, configure the database environment to do checksum verification of pages read into the cache from the backing filestore. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getChecksum()"><!-- --></A><H3> -getChecksum</H3> -<PRE> -public boolean <B>getChecksum</B>()</PRE> -<DL> -<DD>Return true if the database environment is configured to do checksum +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getChecksum()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getChecksum</h4> +<pre>public boolean getChecksum()</pre> +<div class="block">Return true if the database environment is configured to do checksum verification of pages read into the cache from the backing filestore. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database environment is configured to do checksum +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database environment is configured to do checksum verification of pages read into the cache from the backing - filestore.</DL> -</DD> -</DL> -<HR> - -<A NAME="setReadUncommitted(boolean)"><!-- --></A><H3> -setReadUncommitted</H3> -<PRE> -public void <B>setReadUncommitted</B>(boolean readUncommitted)</PRE> -<DL> -<DD>Configure the database to support read uncommitted. + filestore.</dd></dl> +</li> +</ul> +<a name="setReadUncommitted(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReadUncommitted</h4> +<pre>public void setReadUncommitted(boolean readUncommitted)</pre> +<div class="block">Configure the database to support read uncommitted. <p> Read operations on the database may request the return of modified but not yet committed data. This flag must be specified on all - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles used to perform read uncommitted or database + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles used to perform read uncommitted or database updates, otherwise requests for read uncommitted may not be honored and the read may block. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>readUncommitted</CODE> - If true, configure the database to support read uncommitted.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReadUncommitted()"><!-- --></A><H3> -getReadUncommitted</H3> -<PRE> -public boolean <B>getReadUncommitted</B>()</PRE> -<DL> -<DD>Return true if the database is configured to support read uncommitted. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readUncommitted</code> - If true, configure the database to support read uncommitted.</dd></dl> +</li> +</ul> +<a name="getReadUncommitted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReadUncommitted</h4> +<pre>public boolean getReadUncommitted()</pre> +<div class="block">Return true if the database is configured to support read uncommitted. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured to support read uncommitted.</DL> -</DD> -</DL> -<HR> - -<A NAME="setDirtyRead(boolean)"><!-- --></A><H3> -setDirtyRead</H3> -<PRE> -public void <B>setDirtyRead</B>(boolean dirtyRead)</PRE> -<DL> -<DD><B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><CODE>setReadUncommitted(boolean)</CODE></A> to conform to ANSI - database isolation terminology.</I> -<P> -<DD>Configure the database to support read uncommitted. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured to support read uncommitted.</dd></dl> +</li> +</ul> +<a name="setDirtyRead(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDirtyRead</h4> +<pre>public void setDirtyRead(boolean dirtyRead)</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This has been replaced by <a href="../../../com/sleepycat/db/DatabaseConfig.html#setReadUncommitted(boolean)"><code>setReadUncommitted(boolean)</code></a> to conform to ANSI + database isolation terminology.</i></div> +<div class="block">Configure the database to support read uncommitted. <p> Read operations on the database may request the return of modified but not yet committed data. This flag must be specified on all - <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles used to perform read uncommitted or database + <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles used to perform read uncommitted or database updates, otherwise requests for read uncommitted may not be honored and the read may block. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>dirtyRead</CODE> - If true, configure the database to support read uncommitted. - <p></DL> -</DD> -</DL> -<HR> - -<A NAME="getDirtyRead()"><!-- --></A><H3> -getDirtyRead</H3> -<PRE> -public boolean <B>getDirtyRead</B>()</PRE> -<DL> -<DD><B>Deprecated.</B> <I>This has been replaced by <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><CODE>getReadUncommitted()</CODE></A> to conform to ANSI - database isolation terminology.</I> -<P> -<DD>Return true if the database is configured to support read uncommitted. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dirtyRead</code> - If true, configure the database to support read uncommitted. + <p></dd></dl> +</li> +</ul> +<a name="getDirtyRead()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDirtyRead</h4> +<pre>public boolean getDirtyRead()</pre> +<div class="block"><span class="strong">Deprecated.</span> <i>This has been replaced by <a href="../../../com/sleepycat/db/DatabaseConfig.html#getReadUncommitted()"><code>getReadUncommitted()</code></a> to conform to ANSI + database isolation terminology.</i></div> +<div class="block">Return true if the database is configured to support read uncommitted. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured to support read uncommitted. - <p></DL> -</DD> -</DL> -<HR> - -<A NAME="setDuplicateComparator(java.util.Comparator)"><!-- --></A><H3> -setDuplicateComparator</H3> -<PRE> -public void <B>setDuplicateComparator</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> duplicateComparator)</PRE> -<DL> -<DD>Set the duplicate data item comparison callback. The comparison +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured to support read uncommitted. + <p></dd></dl> +</li> +</ul> +<a name="setDuplicateComparator(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setDuplicateComparator</h4> +<pre>public void setDuplicateComparator(java.util.Comparator duplicateComparator)</pre> +<div class="block">Set the duplicate data item comparison callback. The comparison function is called whenever it is necessary to compare a data item specified by the application with a data item currently stored in the database. This comparator is only used if - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)"><CODE>DatabaseConfig.setSortedDuplicates</CODE></A> is also configured. + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setSortedDuplicates(boolean)"><code>DatabaseConfig.setSortedDuplicates</code></a> is also configured. <p> If no comparison function is specified, the data items are compared lexically, with shorter data items collating before longer data items. @@ -1845,42 +1586,31 @@ public void <B>setDuplicateComparator</B>(<A HREF="http://download.oracle.com/ja the byte array, then you can write a comparison routine that directly examines the contents of the arrays. Otherwise, you have to reconstruct your original objects, and then perform the comparison. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>duplicateComparator</CODE> - the comparison callback for duplicate data items.</DL> -</DD> -</DL> -<HR> - -<A NAME="getDuplicateComparator()"><!-- --></A><H3> -getDuplicateComparator</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getDuplicateComparator</B>()</PRE> -<DL> -<DD>Return the duplicate data item comparison callback. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>the duplicate data item Comparator, or null if the default Comparator - will be used.</DL> -</DD> -</DL> -<HR> - -<A NAME="setEncrypted(java.lang.String)"><!-- --></A><H3> -setEncrypted</H3> -<PRE> -public void <B>setEncrypted</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> password)</PRE> -<DL> -<DD>Set the password used to perform encryption and decryption. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>duplicateComparator</code> - the comparison callback for duplicate data items.</dd></dl> +</li> +</ul> +<a name="getDuplicateComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDuplicateComparator</h4> +<pre>public java.util.Comparator getDuplicateComparator()</pre> +<div class="block">Return the duplicate data item comparison callback. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the duplicate data item Comparator, or null if the default Comparator + will be used.</dd></dl> +</li> +</ul> +<a name="setEncrypted(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setEncrypted</h4> +<pre>public void setEncrypted(java.lang.String password)</pre> +<div class="block">Set the password used to perform encryption and decryption. <p> Because databases opened within environments use the password specified to the environment, it is an error to attempt to set a @@ -1888,55 +1618,43 @@ public void <B>setEncrypted</B>(<A HREF="http://download.oracle.com/javase/1.5.0 <p> Berkeley DB uses the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing - Standard (FIPS) 197) algorithm for encryption or decryption. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getEncrypted()"><!-- --></A><H3> -getEncrypted</H3> -<PRE> -public boolean <B>getEncrypted</B>()</PRE> -<DL> -<DD>Return true if the database has been configured to perform encryption. + Standard (FIPS) 197) algorithm for encryption or decryption.</div> +</li> +</ul> +<a name="getEncrypted()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getEncrypted</h4> +<pre>public boolean getEncrypted()</pre> +<div class="block">Return true if the database has been configured to perform encryption. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database has been configured to perform encryption.</DL> -</DD> -</DL> -<HR> - -<A NAME="setErrorHandler(com.sleepycat.db.ErrorHandler)"><!-- --></A><H3> -setErrorHandler</H3> -<PRE> -public void <B>setErrorHandler</B>(<A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> errorHandler)</PRE> -<DL> -<DD>Set the function to be called if an error occurs. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database has been configured to perform encryption.</dd></dl> +</li> +</ul> +<a name="setErrorHandler(com.sleepycat.db.ErrorHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setErrorHandler</h4> +<pre>public void setErrorHandler(<a href="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> errorHandler)</pre> +<div class="block">Set the function to be called if an error occurs. <p> When an error occurs in the Berkeley DB library, an exception is thrown. In some cases, however, the error information returned to the application may be insufficient to completely describe the cause of the error, especially during initial application debugging. <p> -The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> methods are used to enhance the mechanism for reporting +The <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><code>DatabaseConfig.setErrorHandler</code></a> methods are used to enhance the mechanism for reporting error messages to the application. In some cases, when an error occurs, Berkeley DB will invoke the ErrorHandler's object error method. It is up to this method to display the error message in an appropriate manner. <p> -Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> to +Alternatively, applications can use <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><code>EnvironmentConfig.setErrorStream</code></a> and <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><code>DatabaseConfig.setErrorStream</code></a> to display the additional information via an output stream. Applications should not mix these approaches. <p> @@ -1944,99 +1662,77 @@ This error-logging enhancement does not slow performance or significantly increase application size, and may be run during normal operation as well as during application debugging. <p> -For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, +For <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments, calling this method affects the entire environment and is equivalent to -calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A>. +calling <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><code>EnvironmentConfig.setErrorHandler</code></a>. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - The function to be called if an error occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="getErrorHandler()"><!-- --></A><H3> -getErrorHandler</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</A> <B>getErrorHandler</B>()</PRE> -<DL> -<DD>Return the function to be called if an error occurs. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorHandler</code> - The function to be called if an error occurs.</dd></dl> +</li> +</ul> +<a name="getErrorHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getErrorHandler</h4> +<pre>public <a href="../../../com/sleepycat/db/ErrorHandler.html" title="interface in com.sleepycat.db">ErrorHandler</a> getErrorHandler()</pre> +<div class="block">Return the function to be called if an error occurs. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The function to be called if an error occurs.</DL> -</DD> -</DL> -<HR> - -<A NAME="setErrorPrefix(java.lang.String)"><!-- --></A><H3> -setErrorPrefix</H3> -<PRE> -public void <B>setErrorPrefix</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> errorPrefix)</PRE> -<DL> -<DD>Set the prefix string that appears before error messages. -<p> -For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The function to be called if an error occurs.</dd></dl> +</li> +</ul> +<a name="setErrorPrefix(java.lang.String)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setErrorPrefix</h4> +<pre>public void setErrorPrefix(java.lang.String errorPrefix)</pre> +<div class="block">Set the prefix string that appears before error messages. +<p> +For <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments, calling this method affects the entire environment and is equivalent to -calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><CODE>EnvironmentConfig.setErrorPrefix</CODE></A>. +calling <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><code>EnvironmentConfig.setErrorPrefix</code></a>. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>errorPrefix</CODE> - The prefix string that appears before error messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="getErrorPrefix()"><!-- --></A><H3> -getErrorPrefix</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getErrorPrefix</B>()</PRE> -<DL> -<DD>Return the prefix string that appears before error messages. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorPrefix</code> - The prefix string that appears before error messages.</dd></dl> +</li> +</ul> +<a name="getErrorPrefix()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getErrorPrefix</h4> +<pre>public java.lang.String getErrorPrefix()</pre> +<div class="block">Return the prefix string that appears before error messages. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The prefix string that appears before error messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="setErrorStream(java.io.OutputStream)"><!-- --></A><H3> -setErrorStream</H3> -<PRE> -public void <B>setErrorStream</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> errorStream)</PRE> -<DL> -<DD>Set an OutputStream for displaying error messages. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The prefix string that appears before error messages.</dd></dl> +</li> +</ul> +<a name="setErrorStream(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setErrorStream</h4> +<pre>public void setErrorStream(java.io.OutputStream errorStream)</pre> +<div class="block">Set an OutputStream for displaying error messages. <p> When an error occurs in the Berkeley DB library, an exception is thrown. In some cases, however, the error information returned to the application may be insufficient to completely describe the cause of the error, especially during initial application debugging. <p> -The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setErrorStream</CODE></A> and -<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><CODE>DatabaseConfig.setErrorStream</CODE></A> methods are used to enhance +The <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorStream(java.io.OutputStream)"><code>EnvironmentConfig.setErrorStream</code></a> and +<a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorStream(java.io.OutputStream)"><code>DatabaseConfig.setErrorStream</code></a> methods are used to enhance the mechanism for reporting error messages to the application by setting a OutputStream to be used for displaying additional Berkeley DB error messages. In some cases, when an error occurs, Berkeley DB will output @@ -2044,11 +1740,11 @@ an additional error message to the specified stream. <p> The error message will consist of the prefix string and a colon ("<b>:</b>") (if a prefix string was previously specified using -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><CODE>EnvironmentConfig.setErrorPrefix</CODE></A> or <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)"><CODE>DatabaseConfig.setErrorPrefix</CODE></A>), an error string, and a trailing newline character. +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorPrefix(java.lang.String)"><code>EnvironmentConfig.setErrorPrefix</code></a> or <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorPrefix(java.lang.String)"><code>DatabaseConfig.setErrorPrefix</code></a>), an error string, and a trailing newline character. <p> Setting errorStream to null unconfigures the interface. <p> -Alternatively, applications can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>EnvironmentConfig.setErrorHandler</CODE></A> and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><CODE>DatabaseConfig.setErrorHandler</CODE></A> to capture +Alternatively, applications can use <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><code>EnvironmentConfig.setErrorHandler</code></a> and <a href="../../../com/sleepycat/db/DatabaseConfig.html#setErrorHandler(com.sleepycat.db.ErrorHandler)"><code>DatabaseConfig.setErrorHandler</code></a> to capture the additional error information in a way that does not use output streams. Applications should not mix these approaches. <p> @@ -2057,87 +1753,65 @@ increase application size, and may be run during normal operation as well as during application debugging. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>errorStream</CODE> - The application-specified OutputStream for error messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="getErrorStream()"><!-- --></A><H3> -getErrorStream</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> <B>getErrorStream</B>()</PRE> -<DL> -<DD>Return the an OutputStream for displaying error messages. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>errorStream</code> - The application-specified OutputStream for error messages.</dd></dl> +</li> +</ul> +<a name="getErrorStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getErrorStream</h4> +<pre>public java.io.OutputStream getErrorStream()</pre> +<div class="block">Return the an OutputStream for displaying error messages. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The an OutputStream for displaying error messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="setExclusiveCreate(boolean)"><!-- --></A><H3> -setExclusiveCreate</H3> -<PRE> -public void <B>setExclusiveCreate</B>(boolean exclusiveCreate)</PRE> -<DL> -<DD>Configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to fail if +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The an OutputStream for displaying error messages.</dd></dl> +</li> +</ul> +<a name="setExclusiveCreate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setExclusiveCreate</h4> +<pre>public void setExclusiveCreate(boolean exclusiveCreate)</pre> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to fail if the database already exists. <p> The exclusiveCreate mode is only meaningful if specified with the allowCreate mode. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>exclusiveCreate</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method to - fail if the database already exists.</DL> -</DD> -</DL> -<HR> - -<A NAME="getExclusiveCreate()"><!-- --></A><H3> -getExclusiveCreate</H3> -<PRE> -public boolean <B>getExclusiveCreate</B>()</PRE> -<DL> -<DD>Return true if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>exclusiveCreate</code> - If true, configure the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method to + fail if the database already exists.</dd></dl> +</li> +</ul> +<a name="getExclusiveCreate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getExclusiveCreate</h4> +<pre>public boolean getExclusiveCreate()</pre> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured to fail if the database already exists. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction, java.lang.String, java.lang.String, com.sleepycat.db.DatabaseConfig)"><CODE>Environment.openDatabase</CODE></A> method is configured - to fail if the database already exists.</DL> -</DD> -</DL> -<HR> - -<A NAME="setFeedbackHandler(com.sleepycat.db.FeedbackHandler)"><!-- --></A><H3> -setFeedbackHandler</H3> -<PRE> -public void <B>setFeedbackHandler</B>(<A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> feedbackHandler)</PRE> -<DL> -<DD>Set an object whose methods are called to provide feedback. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the <a href="../../../com/sleepycat/db/Environment.html#openDatabase(com.sleepycat.db.Transaction,%20java.lang.String,%20java.lang.String,%20com.sleepycat.db.DatabaseConfig)"><code>Environment.openDatabase</code></a> method is configured + to fail if the database already exists.</dd></dl> +</li> +</ul> +<a name="setFeedbackHandler(com.sleepycat.db.FeedbackHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFeedbackHandler</h4> +<pre>public void setFeedbackHandler(<a href="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> feedbackHandler)</pre> +<div class="block">Set an object whose methods are called to provide feedback. <p> Some operations performed by the Berkeley DB library can take non-trivial amounts of time. This method can be used by applications @@ -2149,46 +1823,35 @@ It is up to the object's methods to display this information in an appropriate manner. <p> This method configures only operations performed using a single a -<A HREF="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><CODE>Environment</CODE></A> handle +<a href="../../../com/sleepycat/db/Environment.html" title="class in com.sleepycat.db"><code>Environment</code></a> handle <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>feedbackHandler</CODE> - An object whose methods are called to provide feedback.</DL> -</DD> -</DL> -<HR> - -<A NAME="getFeedbackHandler()"><!-- --></A><H3> -getFeedbackHandler</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</A> <B>getFeedbackHandler</B>()</PRE> -<DL> -<DD>Return the object's methods to be called to provide feedback. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>feedbackHandler</code> - An object whose methods are called to provide feedback.</dd></dl> +</li> +</ul> +<a name="getFeedbackHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFeedbackHandler</h4> +<pre>public <a href="../../../com/sleepycat/db/FeedbackHandler.html" title="interface in com.sleepycat.db">FeedbackHandler</a> getFeedbackHandler()</pre> +<div class="block">Return the object's methods to be called to provide feedback. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The object's methods to be called to provide feedback.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHashFillFactor(int)"><!-- --></A><H3> -setHashFillFactor</H3> -<PRE> -public void <B>setHashFillFactor</B>(int hashFillFactor)</PRE> -<DL> -<DD>Set the desired density within the hash table. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The object's methods to be called to provide feedback.</dd></dl> +</li> +</ul> +<a name="setHashFillFactor(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHashFillFactor</h4> +<pre>public void setHashFillFactor(int hashFillFactor)</pre> +<div class="block">Set the desired density within the hash table. <p> If no value is specified, the fill factor will be selected dynamically as pages are filled. @@ -2203,48 +1866,37 @@ public void <B>setHashFillFactor</B>(int hashFillFactor)</PRE> </pre></blockquote> <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>hashFillFactor</CODE> - The desired density within the hash table.</DL> -</DD> -</DL> -<HR> - -<A NAME="getHashFillFactor()"><!-- --></A><H3> -getHashFillFactor</H3> -<PRE> -public int <B>getHashFillFactor</B>()</PRE> -<DL> -<DD>Return the hash table density. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hashFillFactor</code> - The desired density within the hash table.</dd></dl> +</li> +</ul> +<a name="getHashFillFactor()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashFillFactor</h4> +<pre>public int getHashFillFactor()</pre> +<div class="block">Return the hash table density. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The hash table density.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHashComparator(java.util.Comparator)"><!-- --></A><H3> -setHashComparator</H3> -<PRE> -public void <B>setHashComparator</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> hashComparator)</PRE> -<DL> -<DD>Set the Hash key comparison function. The comparison function is called +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The hash table density.</dd></dl> +</li> +</ul> +<a name="setHashComparator(java.util.Comparator)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHashComparator</h4> +<pre>public void setHashComparator(java.util.Comparator hashComparator)</pre> +<div class="block">Set the Hash key comparison function. The comparison function is called whenever it is necessary to compare a key specified by the application with a key currently stored in the database. <p> @@ -2255,43 +1907,31 @@ public void <B>setHashComparator</B>(<A HREF="http://download.oracle.com/javase/ keys that are stored in the database. If you know how your data is organized in the byte array, then you can write a comparison routine that directly examines the contents of the arrays. Otherwise, you have to - reconstruct your original objects, and then perform the comparison. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -</DL> -</DD> -</DL> -<HR> - -<A NAME="getHashComparator()"><!-- --></A><H3> -getHashComparator</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/util/Comparator.html?is-external=true" title="class or interface in java.util">Comparator</A> <B>getHashComparator</B>()</PRE> -<DL> -<DD>Return the Comparator used to compare keys in a Hash database. + reconstruct your original objects, and then perform the comparison.</div> +</li> +</ul> +<a name="getHashComparator()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashComparator</h4> +<pre>public java.util.Comparator getHashComparator()</pre> +<div class="block">Return the Comparator used to compare keys in a Hash database. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The Comparator used to compare keys in a Hash database.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHasher(com.sleepycat.db.Hasher)"><!-- --></A><H3> -setHasher</H3> -<PRE> -public void <B>setHasher</B>(<A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> hasher)</PRE> -<DL> -<DD>Set a database-specific hash function. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The Comparator used to compare keys in a Hash database.</dd></dl> +</li> +</ul> +<a name="setHasher(com.sleepycat.db.Hasher)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHasher</h4> +<pre>public void setHasher(<a href="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</a> hasher)</pre> +<div class="block">Set a database-specific hash function. <p> If no hash function is specified, a default hash function is used. Because no hash function performs equally well on all possible data, @@ -2299,317 +1939,265 @@ public void <B>setHasher</B>(<A HREF="../../../com/sleepycat/db/Hasher.html" tit with a particular data set. <p> This method configures operations performed using the specified -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying database. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method must be the same as that historically used to create the database or corruption can occur. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>hasher</CODE> - A database-specific hash function.</DL> -</DD> -</DL> -<HR> - -<A NAME="getHasher()"><!-- --></A><H3> -getHasher</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</A> <B>getHasher</B>()</PRE> -<DL> -<DD>Return the database-specific hash function. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hasher</code> - A database-specific hash function.</dd></dl> +</li> +</ul> +<a name="getHasher()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHasher</h4> +<pre>public <a href="../../../com/sleepycat/db/Hasher.html" title="interface in com.sleepycat.db">Hasher</a> getHasher()</pre> +<div class="block">Return the database-specific hash function. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The database-specific hash function.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHashNumElements(int)"><!-- --></A><H3> -setHashNumElements</H3> -<PRE> -public void <B>setHashNumElements</B>(int hashNumElements)</PRE> -<DL> -<DD>Set an estimate of the final size of the hash table. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The database-specific hash function.</dd></dl> +</li> +</ul> +<a name="setHashNumElements(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHashNumElements</h4> +<pre>public void setHashNumElements(int hashNumElements)</pre> +<div class="block">Set an estimate of the final size of the hash table. <p> In order for the estimate to be used when creating the database, the - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)"><CODE>DatabaseConfig.setHashFillFactor</CODE></A> method must also be called. + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setHashFillFactor(int)"><code>DatabaseConfig.setHashFillFactor</code></a> method must also be called. If the estimate or fill factor are not set or are set too low, hash tables will still expand gracefully as keys are entered, although a slight performance degradation may be noticed. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>hashNumElements</CODE> - An estimate of the final size of the hash table.</DL> -</DD> -</DL> -<HR> - -<A NAME="getHashNumElements()"><!-- --></A><H3> -getHashNumElements</H3> -<PRE> -public int <B>getHashNumElements</B>()</PRE> -<DL> -<DD>Return the estimate of the final size of the hash table. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>hashNumElements</code> - An estimate of the final size of the hash table.</dd></dl> +</li> +</ul> +<a name="getHashNumElements()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHashNumElements</h4> +<pre>public int getHashNumElements()</pre> +<div class="block">Return the estimate of the final size of the hash table. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The estimate of the final size of the hash table.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHeapsize(long)"><!-- --></A><H3> -setHeapsize</H3> -<PRE> -public void <B>setHeapsize</B>(long bytes)</PRE> -<DL> -<DD>Set the maximum on-disk database file size used by a database configured to +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The estimate of the final size of the hash table.</dd></dl> +</li> +</ul> +<a name="setHeapsize(long)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHeapsize</h4> +<pre>public void setHeapsize(long bytes)</pre> +<div class="block">Set the maximum on-disk database file size used by a database configured to use the Heap access method. If this method is never called, the database's file size can grow without bound. If this method is called, then the heap file can never grow larger than the limit defined by this method. In that case, attempts to update or create records in a Heap database that has - reached its maximum size will throw a <A HREF="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><CODE>HeapFullException</CODE></A>. + reached its maximum size will throw a <a href="../../../com/sleepycat/db/HeapFullException.html" title="class in com.sleepycat.db"><code>HeapFullException</code></a>. <p> The size specified to this method must be at least three times the database page size. That is, a Heap database must contain at least three database - pages. You can set the database page size using <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)"><CODE>setPageSize(int)</CODE></A>. + pages. You can set the database page size using <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)"><code>setPageSize(int)</code></a>. <p> This method may not be called after the database is opened. Further, if this method is called on an existing Heap database, the size specified here must match the size used to create the database. Note, however, that specifying an incorrect size to this method will not result in an error return until the database is opened. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>bytes</CODE> - The maximum on-disk database file size.</DL> -</DD> -</DL> -<HR> - -<A NAME="getHeapsize()"><!-- --></A><H3> -getHeapsize</H3> -<PRE> -public long <B>getHeapsize</B>()</PRE> -<DL> -<DD>Return the maximum on-disk database file size. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>bytes</code> - The maximum on-disk database file size.</dd></dl> +</li> +</ul> +<a name="getHeapsize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeapsize</h4> +<pre>public long getHeapsize()</pre> +<div class="block">Return the maximum on-disk database file size. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The maximum on-disk database file size.</DL> -</DD> -</DL> -<HR> - -<A NAME="setHeapRegionSize(int)"><!-- --></A><H3> -setHeapRegionSize</H3> -<PRE> -public void <B>setHeapRegionSize</B>(int npages)</PRE> -<DL> -<DD>Sets the number of pages in a region of a database configured to use + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The maximum on-disk database file size.</dd></dl> +</li> +</ul> +<a name="setHeapRegionSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHeapRegionSize</h4> +<pre>public void setHeapRegionSize(int npages)</pre> +<div class="block">Sets the number of pages in a region of a database configured to use the Heap access method. If this method is never called, the default region size for the database's page size will be used. You can set the database - page size using <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)"><CODE>setPageSize(int)</CODE></A>. + page size using <a href="../../../com/sleepycat/db/DatabaseConfig.html#setPageSize(int)"><code>setPageSize(int)</code></a>. <p> This method may not be called after the database is opened. Further, if this method is called on an existing Heap database, the value specified here will be ignored. If the specified region size is larger than the maximum region size for the database's page size, an error will be returned when the database is opened. The maximum allowable region size will be included in - the error message. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>npages</CODE> - The size of the region, in pages.</DL> -</DD> -</DL> -<HR> - -<A NAME="getHeapRegionSize()"><!-- --></A><H3> -getHeapRegionSize</H3> -<PRE> -public long <B>getHeapRegionSize</B>()</PRE> -<DL> -<DD>Return the number of pages in a region of the database. + the error message.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>npages</code> - The size of the region, in pages.</dd></dl> +</li> +</ul> +<a name="getHeapRegionSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeapRegionSize</h4> +<pre>public long getHeapRegionSize()</pre> +<div class="block">Return the number of pages in a region of the database. <p> This method may be called at any time during the life of the application. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The size of the region, in pages.</DL> -</DD> -</DL> -<HR> - -<A NAME="setMessageHandler(com.sleepycat.db.MessageHandler)"><!-- --></A><H3> -setMessageHandler</H3> -<PRE> -public void <B>setMessageHandler</B>(<A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> messageHandler)</PRE> -<DL> -<DD>Set a function to be called with an informational message. + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The size of the region, in pages.</dd></dl> +</li> +</ul> +<a name="setMessageHandler(com.sleepycat.db.MessageHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMessageHandler</h4> +<pre>public void setMessageHandler(<a href="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> messageHandler)</pre> +<div class="block">Set a function to be called with an informational message. <p> There are interfaces in the Berkeley DB library which either directly output informational messages or statistical information, or configure the library to output such messages when performing other operations, -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example. +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example. <p> -The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A> and -<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> methods are used to display +The <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><code>EnvironmentConfig.setMessageHandler</code></a> and +<a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><code>DatabaseConfig.setMessageHandler</code></a> methods are used to display these messages for the application. <p> Setting messageHandler to null unconfigures the interface. <p> -Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A> -and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> to send the additional +Alternatively, you can use <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><code>EnvironmentConfig.setMessageStream</code></a> +and <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><code>DatabaseConfig.setMessageStream</code></a> to send the additional information directly to an output streams. You should not mix these approaches. <p> -For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, +For <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments, calling this method affects the entire environment and is equivalent to -calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A>. +calling <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><code>EnvironmentConfig.setMessageHandler</code></a>. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>messageHandler</CODE> - The application-specified function for informational messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMessageHandler()"><!-- --></A><H3> -getMessageHandler</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</A> <B>getMessageHandler</B>()</PRE> -<DL> -<DD>Return the function to be called with an informational message. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageHandler</code> - The application-specified function for informational messages.</dd></dl> +</li> +</ul> +<a name="getMessageHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessageHandler</h4> +<pre>public <a href="../../../com/sleepycat/db/MessageHandler.html" title="interface in com.sleepycat.db">MessageHandler</a> getMessageHandler()</pre> +<div class="block">Return the function to be called with an informational message. <p> This method may be called at any time during the life of the application. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The function to be called with an informational message.</dd></dl> +</li> +</ul> +<a name="setMsgfile(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMsgfile</h4> +<pre>public void setMsgfile(java.io.File file)</pre> +<div class="block">Sets the path of a file to store statistical information. <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The function to be called with an informational message.</DL> -</DD> -</DL> -<HR> - -<A NAME="setMessageStream(java.io.OutputStream)"><!-- --></A><H3> -setMessageStream</H3> -<PRE> -public void <B>setMessageStream</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> messageStream)</PRE> -<DL> -<DD>Set an OutputStream for displaying informational messages. +This method may be called at any time during the life of the application. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>file</code> - The path of a file to store statistical information.</dd></dl> +</li> +</ul> +<a name="setMessageStream(java.io.OutputStream)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMessageStream</h4> +<pre>public void setMessageStream(java.io.OutputStream messageStream)</pre> +<div class="block">Set an OutputStream for displaying informational messages. <p> There are interfaces in the Berkeley DB library which either directly output informational messages or statistical information, or configure the library to output such messages when performing other operations, -<A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><CODE>EnvironmentConfig.setVerboseDeadlock</CODE></A> for example. +<a href="../../../com/sleepycat/db/EnvironmentConfig.html#setVerboseDeadlock(boolean)"><code>EnvironmentConfig.setVerboseDeadlock</code></a> for example. <p> -The <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A> and -<A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><CODE>DatabaseConfig.setMessageStream</CODE></A> methods are used to display +The <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><code>EnvironmentConfig.setMessageStream</code></a> and +<a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageStream(java.io.OutputStream)"><code>DatabaseConfig.setMessageStream</code></a> methods are used to display these messages for the application. In this case, the message will include a trailing newline character. <p> Setting messageStream to null unconfigures the interface. <p> -Alternatively, you can use <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>EnvironmentConfig.setMessageHandler</CODE></A> -and <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><CODE>DatabaseConfig.setMessageHandler</CODE></A> to capture the additional +Alternatively, you can use <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><code>EnvironmentConfig.setMessageHandler</code></a> +and <a href="../../../com/sleepycat/db/DatabaseConfig.html#setMessageHandler(com.sleepycat.db.MessageHandler)"><code>DatabaseConfig.setMessageHandler</code></a> to capture the additional information in a way that does not use output streams. You should not mix these approaches. <p> -For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, +For <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments, calling this method affects the entire environment and is equivalent to -calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><CODE>EnvironmentConfig.setMessageStream</CODE></A>. +calling <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setMessageStream(java.io.OutputStream)"><code>EnvironmentConfig.setMessageStream</code></a>. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>messageStream</CODE> - The application-specified OutputStream for informational messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMessageStream()"><!-- --></A><H3> -getMessageStream</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/OutputStream.html?is-external=true" title="class or interface in java.io">OutputStream</A> <B>getMessageStream</B>()</PRE> -<DL> -<DD>Return the an OutputStream for displaying informational messages. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>messageStream</code> - The application-specified OutputStream for informational messages.</dd></dl> +</li> +</ul> +<a name="getMessageStream()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMessageStream</h4> +<pre>public java.io.OutputStream getMessageStream()</pre> +<div class="block">Return the an OutputStream for displaying informational messages. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The an OutputStream for displaying informational messages.</DL> -</DD> -</DL> -<HR> - -<A NAME="setMode(int)"><!-- --></A><H3> -setMode</H3> -<PRE> -public void <B>setMode</B>(int mode)</PRE> -<DL> -<DD>On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The an OutputStream for displaying informational messages.</dd></dl> +</li> +</ul> +<a name="setMode(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMode</h4> +<pre>public void setMode(int mode)</pre> +<div class="block">On UNIX systems or in IEEE/ANSI Std 1003.1 (POSIX) environments, files created by the database open are created with mode <code>mode</code> (as described in the <code>chmod</code>(2) manual page) and modified by the process' umask value at the time of creation (see the @@ -2622,185 +2210,141 @@ public void <B>setMode</B>(int mode)</PRE> mode of readable and writable by both owner and group. <p> On Windows systems, the mode parameter is ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>mode</CODE> - the mode used to create files</DL> -</DD> -</DL> -<HR> - -<A NAME="getMode()"><!-- --></A><H3> -getMode</H3> -<PRE> -public long <B>getMode</B>()</PRE> -<DL> -<DD>Return the mode used to create files. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mode</code> - the mode used to create files</dd></dl> +</li> +</ul> +<a name="getMode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMode</h4> +<pre>public long getMode()</pre> +<div class="block">Return the mode used to create files. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The mode used to create files.</DL> -</DD> -</DL> -<HR> - -<A NAME="setMultiversion(boolean)"><!-- --></A><H3> -setMultiversion</H3> -<PRE> -public void <B>setMultiversion</B>(boolean multiversion)</PRE> -<DL> -<DD>Configured the database with support for multiversion concurrency control. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The mode used to create files.</dd></dl> +</li> +</ul> +<a name="setMultiversion(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMultiversion</h4> +<pre>public void setMultiversion(boolean multiversion)</pre> +<div class="block">Configured the database with support for multiversion concurrency control. This will cause updates to the database to follow a copy-on-write protocol, which is required to support Snapshot Isolation. See - <A HREF="../../../com/sleepycat/db/TransactionConfig.html#setSnapshot(boolean)"><CODE>TransactionConfig.setSnapshot(boolean)</CODE></A>) for more information. + <a href="../../../com/sleepycat/db/TransactionConfig.html#setSnapshot(boolean)"><code>TransactionConfig.setSnapshot(boolean)</code></a>) for more information. Multiversion access requires that the database be opened in a transaction and is not supported for queue databases. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>multiversion</CODE> - If true, configure the database with support for multiversion concurrency - control.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMultiversion()"><!-- --></A><H3> -getMultiversion</H3> -<PRE> -public boolean <B>getMultiversion</B>()</PRE> -<DL> -<DD>Return true if the database is configured for multiversion concurrency control. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>multiversion</code> - If true, configure the database with support for multiversion concurrency + control.</dd></dl> +</li> +</ul> +<a name="getMultiversion()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMultiversion</h4> +<pre>public boolean getMultiversion()</pre> +<div class="block">Return true if the database is configured for multiversion concurrency control. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured for multiversion concurrency control.</DL> -</DD> -</DL> -<HR> - -<A NAME="setNoMMap(boolean)"><!-- --></A><H3> -setNoMMap</H3> -<PRE> -public void <B>setNoMMap</B>(boolean noMMap)</PRE> -<DL> -<DD>Configure the library to not map this database into memory. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>noMMap</CODE> - If true, configure the library to not map this database into memory.</DL> -</DD> -</DL> -<HR> - -<A NAME="getNoMMap()"><!-- --></A><H3> -getNoMMap</H3> -<PRE> -public boolean <B>getNoMMap</B>()</PRE> -<DL> -<DD>Return true if the library is configured to not map this database into +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured for multiversion concurrency control.</dd></dl> +</li> +</ul> +<a name="setNoMMap(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNoMMap</h4> +<pre>public void setNoMMap(boolean noMMap)</pre> +<div class="block">Configure the library to not map this database into memory. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>noMMap</code> - If true, configure the library to not map this database into memory.</dd></dl> +</li> +</ul> +<a name="getNoMMap()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNoMMap</h4> +<pre>public boolean getNoMMap()</pre> +<div class="block">Return true if the library is configured to not map this database into memory. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the library is configured to not map this database into - memory.</DL> -</DD> -</DL> -<HR> - -<A NAME="setNoWaitDbExclusiveLock(java.lang.Boolean)"><!-- --></A><H3> -setNoWaitDbExclusiveLock</H3> -<PRE> -public void <B>setNoWaitDbExclusiveLock</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> noWaitDbExclLock)</PRE> -<DL> -<DD>Configure the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle to obtain a +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the library is configured to not map this database into + memory.</dd></dl> +</li> +</ul> +<a name="setNoWaitDbExclusiveLock(java.lang.Boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setNoWaitDbExclusiveLock</h4> +<pre>public void setNoWaitDbExclusiveLock(java.lang.Boolean noWaitDbExclLock)</pre> +<div class="block">Configure the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the entire database. <p> This method may not be called after the database is opened. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>noWaitDbExclLock</CODE> - If True, configure the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle to +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>noWaitDbExclLock</code> - If True, configure the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the entire database. When the database is opened it will immediately throw -<A HREF="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><CODE>LockNotGrantedException</CODE></A> if it +<a href="../../../com/sleepycat/db/LockNotGrantedException.html" title="class in com.sleepycat.db"><code>LockNotGrantedException</code></a> if it cannot obtain the exclusive lock immediately. If False, configure the -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle to obtain a write lock on the +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the entire database. When the database is opened, it will block until it can obtain the exclusive lock. If null, do not configure the -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle to obtain a write lock on the +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle to obtain a write lock on the entire database. <p> Handles configured for a write lock on the entire database can only have one -active transaction at a time.</DL> -</DD> -</DL> -<HR> - -<A NAME="getNoWaitDbExclusiveLock()"><!-- --></A><H3> -getNoWaitDbExclusiveLock</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/lang/Boolean.html?is-external=true" title="class or interface in java.lang">Boolean</A> <B>getNoWaitDbExclusiveLock</B>()</PRE> -<DL> -<DD>Return whether the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle is +active transaction at a time.</dd></dl> +</li> +</ul> +<a name="getNoWaitDbExclusiveLock()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNoWaitDbExclusiveLock</h4> +<pre>public java.lang.Boolean getNoWaitDbExclusiveLock()</pre> +<div class="block">Return whether the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is configured to obtain a write lock on the entire database. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle is configured for +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is configured for immediate exclusive database locking. In this case, the locking operation will error out if it cannot immediately obtain an exclusive lock. False if the -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle is configured for exclusive +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is configured for exclusive database locking. In this case, it will block until it can obtain the exclusive database lock when database is opened. Null if the -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle is not configured for -exclusive locking.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPageSize(int)"><!-- --></A><H3> -setPageSize</H3> -<PRE> -public void <B>setPageSize</B>(int pageSize)</PRE> -<DL> -<DD>Set the size of the pages used to hold items in the database, in bytes. +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle is not configured for +exclusive locking.</dd></dl> +</li> +</ul> +<a name="setPageSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPageSize</h4> +<pre>public void setPageSize(int pageSize)</pre> +<div class="block">Set the size of the pages used to hold items in the database, in bytes. <p> The minimum page size is 512 bytes, the maximum page size is 64K bytes, and the page size must be a power-of-two. If the page size is not @@ -2809,7 +2353,7 @@ public void <B>setPageSize</B>(int pageSize)</PRE> bytes and an upper limit of 16K bytes. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, @@ -2817,287 +2361,218 @@ the information specified to this method will be ignored. If creating additional databases in a file, the page size specified must be consistent with the existing databases in the file or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>pageSize</CODE> - The size of the pages used to hold items in the database, in bytes.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPageSize()"><!-- --></A><H3> -getPageSize</H3> -<PRE> -public int <B>getPageSize</B>()</PRE> -<DL> -<DD>Return the size of the pages used to hold items in the database, in bytes. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pageSize</code> - The size of the pages used to hold items in the database, in bytes.</dd></dl> +</li> +</ul> +<a name="getPageSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPageSize</h4> +<pre>public int getPageSize()</pre> +<div class="block">Return the size of the pages used to hold items in the database, in bytes. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The size of the pages used to hold items in the database, in bytes.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPanicHandler(com.sleepycat.db.PanicHandler)"><!-- --></A><H3> -setPanicHandler</H3> -<PRE> -public void <B>setPanicHandler</B>(<A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> panicHandler)</PRE> -<DL> -<DD>Set the function to be called if the database environment panics. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The size of the pages used to hold items in the database, in bytes.</dd></dl> +</li> +</ul> +<a name="setPanicHandler(com.sleepycat.db.PanicHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPanicHandler</h4> +<pre>public void setPanicHandler(<a href="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> panicHandler)</pre> +<div class="block">Set the function to be called if the database environment panics. <p> Errors can occur in the Berkeley DB library where the only solution is to shut down the application and run recovery (for example, if Berkeley DB is unable to allocate heap memory). In such cases, the Berkeley DB -methods will throw a <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A>. It is often easier +methods will throw a <a href="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a>. It is often easier to simply exit the application when such errors occur rather than gracefully return up the stack. This method specifies a function to be -called when <A HREF="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><CODE>RunRecoveryException</CODE></A> is about to be thrown from a +called when <a href="../../../com/sleepycat/db/RunRecoveryException.html" title="class in com.sleepycat.db"><code>RunRecoveryException</code></a> is about to be thrown from a Berkeley DB method. <p> -For <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handles opened inside of database environments, +For <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handles opened inside of database environments, calling this method affects the entire environment and is equivalent to -calling <A HREF="../../../com/sleepycat/db/EnvironmentConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)"><CODE>EnvironmentConfig.setPanicHandler</CODE></A>. +calling <a href="../../../com/sleepycat/db/EnvironmentConfig.html#setPanicHandler(com.sleepycat.db.PanicHandler)"><code>EnvironmentConfig.setPanicHandler</code></a>. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>panicHandler</CODE> - The function to be called if the database environment panics.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPanicHandler()"><!-- --></A><H3> -getPanicHandler</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</A> <B>getPanicHandler</B>()</PRE> -<DL> -<DD>Return the function to be called if the database environment panics. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>panicHandler</code> - The function to be called if the database environment panics.</dd></dl> +</li> +</ul> +<a name="getPanicHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPanicHandler</h4> +<pre>public <a href="../../../com/sleepycat/db/PanicHandler.html" title="interface in com.sleepycat.db">PanicHandler</a> getPanicHandler()</pre> +<div class="block">Return the function to be called if the database environment panics. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The function to be called if the database environment panics.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPartitionByCallback(int, com.sleepycat.db.PartitionHandler)"><!-- --></A><H3> -setPartitionByCallback</H3> -<PRE> -public void <B>setPartitionByCallback</B>(int parts, - <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> partitionHandler)</PRE> -<DL> -<DD>Enable or disable database partitioning, and set the callback that will +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The function to be called if the database environment panics.</dd></dl> +</li> +</ul> +<a name="setPartitionByCallback(int, com.sleepycat.db.PartitionHandler)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartitionByCallback</h4> +<pre>public void setPartitionByCallback(int parts, + <a href="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a> partitionHandler)</pre> +<div class="block">Enable or disable database partitioning, and set the callback that will be used for the partitioning. <p> This method may only be called before opening a database. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>parts</CODE> - The number of partitions that will be created. -<p><DD><CODE>partitionHandler</CODE> - The function to be called to determine which partition a key resides in.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPartitionByRange(int, com.sleepycat.db.MultipleDataEntry)"><!-- --></A><H3> -setPartitionByRange</H3> -<PRE> -public void <B>setPartitionByRange</B>(int parts, - <A HREF="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</A> keys)</PRE> -<DL> -<DD>Enable or disable database partitioning, and set key ranges that will be +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</code> - The number of partitions that will be created. +<p></dd><dd><code>partitionHandler</code> - The function to be called to determine which partition a key resides in.</dd></dl> +</li> +</ul> +<a name="setPartitionByRange(int, com.sleepycat.db.MultipleDataEntry)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartitionByRange</h4> +<pre>public void setPartitionByRange(int parts, + <a href="../../../com/sleepycat/db/MultipleDataEntry.html" title="class in com.sleepycat.db">MultipleDataEntry</a> keys)</pre> +<div class="block">Enable or disable database partitioning, and set key ranges that will be used for the partitioning. <p> This method may only be called before opening a database. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>parts</CODE> - The number of partitions that will be created. -<p><DD><CODE>keys</CODE> - A MultipleDatabaseEntry that contains the boundary keys for partitioning.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPartitionHandler()"><!-- --></A><H3> -getPartitionHandler</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</A> <B>getPartitionHandler</B>()</PRE> -<DL> -<DD>Return the function to be called to determine which partition a key resides in. +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>parts</code> - The number of partitions that will be created. +<p></dd><dd><code>keys</code> - A MultipleDatabaseEntry that contains the boundary keys for partitioning. +<p></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code>java.lang.IllegalArgumentException</code> - if parts is not equal to the size of key array plus 1.</dd></dl> +</li> +</ul> +<a name="getPartitionHandler()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionHandler</h4> +<pre>public <a href="../../../com/sleepycat/db/PartitionHandler.html" title="interface in com.sleepycat.db">PartitionHandler</a> getPartitionHandler()</pre> +<div class="block">Return the function to be called to determine which partition a key resides in. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The function to be called to determine which partition a key resides in.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPartitionParts()"><!-- --></A><H3> -getPartitionParts</H3> -<PRE> -public int <B>getPartitionParts</B>()</PRE> -<DL> -<DD>Return the number of partitions the database is configured for. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The function to be called to determine which partition a key resides in.</dd></dl> +</li> +</ul> +<a name="getPartitionParts()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionParts</h4> +<pre>public int getPartitionParts()</pre> +<div class="block">Return the number of partitions the database is configured for. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The number of partitions the database is configured for.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPartitionKeys()"><!-- --></A><H3> -getPartitionKeys</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</A> <B>getPartitionKeys</B>()</PRE> -<DL> -<DD>Return the array of keys the database is configured to partition with. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The number of partitions the database is configured for.</dd></dl> +</li> +</ul> +<a name="getPartitionKeys()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionKeys</h4> +<pre>public <a href="../../../com/sleepycat/db/DatabaseEntry.html" title="class in com.sleepycat.db">DatabaseEntry</a> getPartitionKeys()</pre> +<div class="block">Return the array of keys the database is configured to partition with. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The array of keys the database is configured to partition with.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPartitionDirs(java.io.File[])"><!-- --></A><H3> -setPartitionDirs</H3> -<PRE> -public void <B>setPartitionDirs</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] dirs)</PRE> -<DL> -<DD>Specify the array of directories the database extents should be created in or +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The array of keys the database is configured to partition with.</dd></dl> +</li> +</ul> +<a name="setPartitionDirs(java.io.File[])"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPartitionDirs</h4> +<pre>public void setPartitionDirs(java.io.File[] dirs)</pre> +<div class="block">Specify the array of directories the database extents should be created in or looked for. If the number of directories is less than the number of partitions, the directories will be used in a round robin fasion. <p> This method may only be called before the database is opened. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>dirs</CODE> - The array of directories the database extents should be created in or looked -for.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPartitionDirs()"><!-- --></A><H3> -getPartitionDirs</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A>[] <B>getPartitionDirs</B>()</PRE> -<DL> -<DD>Return the array of directories the database extents should be created in or +<p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dirs</code> - The array of directories the database extents should be created in or looked +for.</dd></dl> +</li> +</ul> +<a name="getPartitionDirs()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPartitionDirs</h4> +<pre>public java.io.File[] getPartitionDirs()</pre> +<div class="block">Return the array of directories the database extents should be created in or looked for. If the number of directories is less than the number of partitions, the directories will be used in a round robin fasion. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The array of directories the database extents should be created in or looked -for.</DL> -</DD> -</DL> -<HR> - -<A NAME="setPriority(com.sleepycat.db.CacheFilePriority)"><!-- --></A><H3> -setPriority</H3> -<PRE> -public void <B>setPriority</B>(<A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> priority)</PRE> -<DL> -<DD>Set the cache priority for pages referenced by the DB handle. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The array of directories the database extents should be created in or looked +for.</dd></dl> +</li> +</ul> +<a name="setPriority(com.sleepycat.db.CacheFilePriority)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setPriority</h4> +<pre>public void setPriority(<a href="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> priority)</pre> +<div class="block">Set the cache priority for pages referenced by the DB 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 priority setting is only advisory, and does not guarantee pages will be treated in a specific way. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>priority</CODE> - The desired cache priority.</DL> -</DD> -</DL> -<HR> - -<A NAME="getPriority()"><!-- --></A><H3> -getPriority</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</A> <B>getPriority</B>()</PRE> -<DL> -<DD>Return the the cache priority for pages referenced by this handle. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>priority</code> - The desired cache priority.</dd></dl> +</li> +</ul> +<a name="getPriority()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPriority</h4> +<pre>public <a href="../../../com/sleepycat/db/CacheFilePriority.html" title="class in com.sleepycat.db">CacheFilePriority</a> getPriority()</pre> +<div class="block">Return the the cache priority for pages referenced by this handle. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The the cache priority for pages referenced by this handle.</DL> -</DD> -</DL> -<HR> - -<A NAME="setQueueExtentSize(int)"><!-- --></A><H3> -setQueueExtentSize</H3> -<PRE> -public void <B>setQueueExtentSize</B>(int queueExtentSize)</PRE> -<DL> -<DD>Set the size of the extents used to hold pages in a Queue database, +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The the cache priority for pages referenced by this handle.</dd></dl> +</li> +</ul> +<a name="setQueueExtentSize(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setQueueExtentSize</h4> +<pre>public void setQueueExtentSize(int queueExtentSize)</pre> +<div class="block">Set the size of the extents used to hold pages in a Queue database, specified as a number of pages. <p> Each extent is created as a separate physical file. If no extent @@ -3105,50 +2580,39 @@ public void <B>setQueueExtentSize</B>(int queueExtentSize)</PRE> underlying database file. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>queueExtentSize</CODE> - The number of pages in a Queue database extent.</DL> -</DD> -</DL> -<HR> - -<A NAME="getQueueExtentSize()"><!-- --></A><H3> -getQueueExtentSize</H3> -<PRE> -public int <B>getQueueExtentSize</B>()</PRE> -<DL> -<DD>Return the size of the extents used to hold pages in a Queue database, + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>queueExtentSize</code> - The number of pages in a Queue database extent.</dd></dl> +</li> +</ul> +<a name="getQueueExtentSize()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueueExtentSize</h4> +<pre>public int getQueueExtentSize()</pre> +<div class="block">Return the size of the extents used to hold pages in a Queue database, specified as a number of pages. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The size of the extents used to hold pages in a Queue database, - specified as a number of pages.</DL> -</DD> -</DL> -<HR> - -<A NAME="setQueueInOrder(boolean)"><!-- --></A><H3> -setQueueInOrder</H3> -<PRE> -public void <B>setQueueInOrder</B>(boolean queueInOrder)</PRE> -<DL> -<DD>Configure <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> to return key/data pairs in +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The size of the extents used to hold pages in a Queue database, + specified as a number of pages.</dd></dl> +</li> +</ul> +<a name="setQueueInOrder(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setQueueInOrder</h4> +<pre>public void setQueueInOrder(boolean queueInOrder)</pre> +<div class="block">Configure <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> to return key/data pairs in order, always returning the key/data item from the head of the queue. <p> @@ -3159,146 +2623,113 @@ public void <B>setQueueInOrder</B>(boolean queueInOrder)</PRE> skip some of the initial records when the next call to retrieve a key/data pair returns. <p> - This flag configures the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method to verify + This flag configures the <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> method to verify that the record being returned is in fact the head of the queue. This will increase contention and reduce concurrency when there are many reading threads. <p> - Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle + Calling this method only affects the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle (and any other library handles opened within the scope of that handle). - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>queueInOrder</CODE> - If true, configure the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method to return + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>queueInOrder</code> - If true, configure the <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> method to return key/data pairs in order, always returning the key/data item from the head of the queue. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getQueueInOrder()"><!-- --></A><H3> -getQueueInOrder</H3> -<PRE> -public boolean <B>getQueueInOrder</B>()</PRE> -<DL> -<DD>Return true if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getQueueInOrder()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getQueueInOrder</h4> +<pre>public boolean getQueueInOrder()</pre> +<div class="block">Return true if the <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> method is configured to return key/data pairs in order, always returning the key/data item from the head of the queue. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the <A HREF="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, boolean)"><CODE>Database.consume</CODE></A> method is configured to return +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the <a href="../../../com/sleepycat/db/Database.html#consume(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20boolean)"><code>Database.consume</code></a> method is configured to return key/data pairs in order, always returning the key/data item from the - head of the queue.</DL> -</DD> -</DL> -<HR> - -<A NAME="setReadOnly(boolean)"><!-- --></A><H3> -setReadOnly</H3> -<PRE> -public void <B>setReadOnly</B>(boolean readOnly)</PRE> -<DL> -<DD>Configure the database in read-only mode. + head of the queue.</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 the database in read-only mode. <p> Any attempt to modify items in the database will fail, regardless of the actual permissions of any underlying files. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>readOnly</CODE> - If true, configure the database in read-only mode.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReadOnly()"><!-- --></A><H3> -getReadOnly</H3> -<PRE> -public boolean <B>getReadOnly</B>()</PRE> -<DL> -<DD>Return true if the database is configured in read-only mode. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>readOnly</code> - If true, configure the database in read-only mode.</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 true if the database is configured in read-only mode. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured in read-only mode.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)"><!-- --></A><H3> -setRecordNumberAppender</H3> -<PRE> -public void <B>setRecordNumberAppender</B>(<A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> recnoAppender)</PRE> -<DL> -<DD>Configure <A HREF="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry)"><CODE>Database.append</CODE></A> to call the function after the +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured in read-only mode.</dd></dl> +</li> +</ul> +<a name="setRecordNumberAppender(com.sleepycat.db.RecordNumberAppender)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordNumberAppender</h4> +<pre>public void setRecordNumberAppender(<a href="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a> recnoAppender)</pre> +<div class="block">Configure <a href="../../../com/sleepycat/db/Database.html#append(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry)"><code>Database.append</code></a> to call the function after the record number has been selected but before the data has been stored into the database. <p> This method configures operations performed using the specified -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying database. <p> This method may not be called after the database is opened. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recnoAppender</CODE> - The function to call after the record number has been selected but - before the data has been stored into the database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordNumberAppender()"><!-- --></A><H3> -getRecordNumberAppender</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</A> <B>getRecordNumberAppender</B>()</PRE> -<DL> -<DD>Return the function to call after the record number has been + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recnoAppender</code> - The function to call after the record number has been selected but + before the data has been stored into the database.</dd></dl> +</li> +</ul> +<a name="getRecordNumberAppender()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordNumberAppender</h4> +<pre>public <a href="../../../com/sleepycat/db/RecordNumberAppender.html" title="interface in com.sleepycat.db">RecordNumberAppender</a> getRecordNumberAppender()</pre> +<div class="block">Return the function to call after the record number has been selected but before the data has been stored into the database. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The function to call after the record number has been - selected but before the data has been stored into the database.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordDelimiter(int)"><!-- --></A><H3> -setRecordDelimiter</H3> -<PRE> -public void <B>setRecordDelimiter</B>(int recordDelimiter)</PRE> -<DL> -<DD>Set the delimiting byte used to mark the end of a record in the backing +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The function to call after the record number has been + selected but before the data has been stored into the database.</dd></dl> +</li> +</ul> +<a name="setRecordDelimiter(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordDelimiter</h4> +<pre>public void setRecordDelimiter(int recordDelimiter)</pre> +<div class="block">Set the delimiting byte used to mark the end of a record in the backing source file for the Recno access method. <p> This byte is used for variable length records if a backing source @@ -3307,51 +2738,40 @@ public void <B>setRecordDelimiter</B>(int recordDelimiter)</PRE> 0x0a) are interpreted as end-of-record markers. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recordDelimiter</CODE> - The delimiting byte used to mark the end of a record in the backing - source file for the Recno access method.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordDelimiter()"><!-- --></A><H3> -getRecordDelimiter</H3> -<PRE> -public int <B>getRecordDelimiter</B>()</PRE> -<DL> -<DD>Return the delimiting byte used to mark the end of a record in the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordDelimiter</code> - The delimiting byte used to mark the end of a record in the backing + source file for the Recno access method.</dd></dl> +</li> +</ul> +<a name="getRecordDelimiter()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordDelimiter</h4> +<pre>public int getRecordDelimiter()</pre> +<div class="block">Return the delimiting byte used to mark the end of a record in the backing source file for the Recno access method. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The delimiting byte used to mark the end of a record in the - backing source file for the Recno access method.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordLength(int)"><!-- --></A><H3> -setRecordLength</H3> -<PRE> -public void <B>setRecordLength</B>(int recordLength)</PRE> -<DL> -<DD>Specify the database record length, in bytes. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The delimiting byte used to mark the end of a record in the + backing source file for the Recno access method.</dd></dl> +</li> +</ul> +<a name="setRecordLength(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordLength</h4> +<pre>public void setRecordLength(int recordLength)</pre> +<div class="block">Specify the database record length, in bytes. <p> For the Queue access method, specify the record length. For the Queue access method, the record length must be enough smaller than @@ -3363,54 +2783,43 @@ public void <B>setRecordLength</B>(int recordLength)</PRE> <p> Any records added to the database that are less than the specified length are automatically padded (see - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)"><CODE>DatabaseConfig.setRecordPad</CODE></A> for more information). + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordPad(int)"><code>DatabaseConfig.setRecordPad</code></a> for more information). <p> Any attempt to insert records into the database that are greater than the specified length will cause the call to fail. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recordLength</CODE> - The database record length, in bytes.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordLength()"><!-- --></A><H3> -getRecordLength</H3> -<PRE> -public int <B>getRecordLength</B>()</PRE> -<DL> -<DD>Return the database record length, in bytes. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordLength</code> - The database record length, in bytes.</dd></dl> +</li> +</ul> +<a name="getRecordLength()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordLength</h4> +<pre>public int getRecordLength()</pre> +<div class="block">Return the database record length, in bytes. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The database record length, in bytes.</DL> -</DD> -</DL> -<HR> - -<A NAME="setBtreeRecordNumbers(boolean)"><!-- --></A><H3> -setBtreeRecordNumbers</H3> -<PRE> -public void <B>setBtreeRecordNumbers</B>(boolean btreeRecordNumbers)</PRE> -<DL> -<DD>Configure the Btree to support retrieval by record number. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The database record length, in bytes.</dd></dl> +</li> +</ul> +<a name="setBtreeRecordNumbers(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setBtreeRecordNumbers</h4> +<pre>public void setBtreeRecordNumbers(boolean btreeRecordNumbers)</pre> +<div class="block">Configure the Btree to support retrieval by record number. <p> Logical record numbers in Btree databases are mutable in the face of record insertion or deletion. @@ -3433,96 +2842,74 @@ control accessing the database. configuration specified by this method must be the same as the existing database or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>btreeRecordNumbers</CODE> - If true, configure the Btree to support retrieval by record number. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>btreeRecordNumbers</code> - If true, configure the Btree to support retrieval by record number. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getBtreeRecordNumbers()"><!-- --></A><H3> -getBtreeRecordNumbers</H3> -<PRE> -public boolean <B>getBtreeRecordNumbers</B>()</PRE> -<DL> -<DD>Return true if the Btree is configured to support retrieval by record number. +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getBtreeRecordNumbers()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getBtreeRecordNumbers</h4> +<pre>public boolean getBtreeRecordNumbers()</pre> +<div class="block">Return true if the Btree is configured to support retrieval by record number. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the Btree is configured to support retrieval by record number.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordPad(int)"><!-- --></A><H3> -setRecordPad</H3> -<PRE> -public void <B>setRecordPad</B>(int recordPad)</PRE> -<DL> -<DD>Set the padding character for short, fixed-length records for the Queue +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the Btree is configured to support retrieval by record number.</dd></dl> +</li> +</ul> +<a name="setRecordPad(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordPad</h4> +<pre>public void setRecordPad(int recordPad)</pre> +<div class="block">Set the padding character for short, fixed-length records for the Queue and Recno access methods. <p> If no pad character is specified, "space" characters (that is, ASCII 0x20) are used for padding. <p> This method configures a database, not only operations performed using -the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle. +the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method will be ignored. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recordPad</CODE> - The padding character for short, fixed-length records for the Queue - and Recno access methods.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordPad()"><!-- --></A><H3> -getRecordPad</H3> -<PRE> -public int <B>getRecordPad</B>()</PRE> -<DL> -<DD>Return the padding character for short, fixed-length records for the + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordPad</code> - The padding character for short, fixed-length records for the Queue + and Recno access methods.</dd></dl> +</li> +</ul> +<a name="getRecordPad()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordPad</h4> +<pre>public int getRecordPad()</pre> +<div class="block">Return the padding character for short, fixed-length records for the Queue and Recno access methods. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The padding character for short, fixed-length records for the - Queue and Recno access methods.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRecordSource(java.io.File)"><!-- --></A><H3> -setRecordSource</H3> -<PRE> -public void <B>setRecordSource</B>(<A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> recordSource)</PRE> -<DL> -<DD>Set the underlying source file for the Recno access method. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The padding character for short, fixed-length records for the + Queue and Recno access methods.</dd></dl> +</li> +</ul> +<a name="setRecordSource(java.io.File)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRecordSource</h4> +<pre>public void setRecordSource(java.io.File recordSource)</pre> +<div class="block">Set the underlying source file for the Recno access method. <p> The purpose of the source file is to provide fast access and modification to databases that are normally stored as flat text @@ -3532,14 +2919,14 @@ public void <B>setRecordSource</B>(<A HREF="http://download.oracle.com/javase/1. database file that is read to initialize a transient record number index. In the case of variable length records, the records are separated, as specified by the - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><CODE>DatabaseConfig.setRecordDelimiter</CODE></A> method. For example, + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><code>DatabaseConfig.setRecordDelimiter</code></a> method. For example, standard UNIX byte stream files can be interpreted as a sequence of variable length records separated by newline characters (that is, ASCII 0x0a). <p> In addition, when cached data would normally be written back to the - underlying database file (for example, the <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> - or <A HREF="../../../com/sleepycat/db/Database.html#sync()"><CODE>Database.sync</CODE></A> methods are called), the in-memory copy + underlying database file (for example, the <a href="../../../com/sleepycat/db/Database.html#close(boolean)"><code>Database.close</code></a> + or <a href="../../../com/sleepycat/db/Database.html#sync()"><code>Database.sync</code></a> methods are called), the in-memory copy of the database will be written back to the source file. <p> By default, the backing source file is read lazily; that is, records @@ -3550,13 +2937,13 @@ public void <B>setRecordSource</B>(<A HREF="http://download.oracle.com/javase/1. source file must be read in its entirety before more than a single process accesses the database, and only that process should specify the backing source file as part of opening the database. See the - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)"><CODE>DatabaseConfig.setSnapshot</CODE></A> method for more information. + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setSnapshot(boolean)"><code>DatabaseConfig.setSnapshot</code></a> method for more information. </b> <p> <b> Reading and writing the backing source file cannot be transaction-protected because it involves filesystem operations that - are not part of the <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> transaction methodology. For + are not part of the <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> transaction methodology. For this reason, if a temporary database is used to hold the records, it is possible to lose the contents of the source file, for example, if the system crashes at the right instant. If a file is used to @@ -3571,9 +2958,9 @@ public void <B>setRecordSource</B>(<A HREF="http://download.oracle.com/javase/1. It is not an error to specify a read-only source file when creating a database, nor is it an error to modify the resulting database. However, any attempt to write the changes to the backing source file - using either the <A HREF="../../../com/sleepycat/db/Database.html#sync()"><CODE>Database.sync</CODE></A> or <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> + using either the <a href="../../../com/sleepycat/db/Database.html#sync()"><code>Database.sync</code></a> or <a href="../../../com/sleepycat/db/Database.html#close(boolean)"><code>Database.close</code></a> methods will fail, of course. Specify the noSync argument to the - <A HREF="../../../com/sleepycat/db/Database.html#close(boolean)"><CODE>Database.close</CODE></A> method to stop it from attempting to write + <a href="../../../com/sleepycat/db/Database.html#close(boolean)"><code>Database.close</code></a> method to stop it from attempting to write the changes to the backing file; instead, they will be silently discarded. <p> @@ -3584,58 +2971,47 @@ public void <B>setRecordSource</B>(<A HREF="http://download.oracle.com/javase/1. editor. <p> This method configures operations performed using the specified -<A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> object, not all operations performed on the underlying +<a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> object, not all operations performed on the underlying database. <p> This method may not be called after the database is opened. If the database already exists when it is opened, the information specified to this method must be the same as that historically used to create the database or corruption can occur. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>recordSource</CODE> - The name of an underlying flat text database file that is read to + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>recordSource</code> - The name of an underlying flat text database file that is read to initialize a transient record number index. In the case of variable length records, the records are separated, as specified by the - <A HREF="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><CODE>DatabaseConfig.setRecordDelimiter</CODE></A> method. For example, + <a href="../../../com/sleepycat/db/DatabaseConfig.html#setRecordDelimiter(int)"><code>DatabaseConfig.setRecordDelimiter</code></a> method. For example, standard UNIX byte stream files can be interpreted as a sequence of variable length records separated by newline characters (that is, ASCII - 0x0a).</DL> -</DD> -</DL> -<HR> - -<A NAME="getRecordSource()"><!-- --></A><H3> -getRecordSource</H3> -<PRE> -public <A HREF="http://download.oracle.com/javase/1.5.0/docs/api/java/io/File.html?is-external=true" title="class or interface in java.io">File</A> <B>getRecordSource</B>()</PRE> -<DL> -<DD>Return the name of an underlying flat text database file that is + 0x0a).</dd></dl> +</li> +</ul> +<a name="getRecordSource()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRecordSource</h4> +<pre>public java.io.File getRecordSource()</pre> +<div class="block">Return the name of an underlying flat text database file that is read to initialize a transient record number index. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The name of an underlying flat text database file that is - read to initialize a transient record number index.</DL> -</DD> -</DL> -<HR> - -<A NAME="setRenumbering(boolean)"><!-- --></A><H3> -setRenumbering</H3> -<PRE> -public void <B>setRenumbering</B>(boolean renumbering)</PRE> -<DL> -<DD>Configure the logical record numbers to be mutable, and change as +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The name of an underlying flat text database file that is + read to initialize a transient record number index.</dd></dl> +</li> +</ul> +<a name="setRenumbering(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setRenumbering</h4> +<pre>public void setRenumbering(boolean renumbering)</pre> +<div class="block">Configure the logical record numbers to be mutable, and change as records are added to and deleted from the database. <p> For example, the deletion of record number 4 causes records numbered @@ -3652,7 +3028,7 @@ public void <B>setRenumbering</B>(boolean renumbering)</PRE> record 25 was previously the last record in the database, will create records 26 and 27 as well as 28. Attempts to retrieve records that were created in this manner will result in an error - return of <A HREF="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><CODE>OperationStatus.KEYEMPTY</CODE></A>. + return of <a href="../../../com/sleepycat/db/OperationStatus.html#KEYEMPTY"><code>OperationStatus.KEYEMPTY</code></a>. <p> If a created record is not at the end of the database, all records following the new record will be automatically renumbered upward by one. @@ -3673,48 +3049,37 @@ control accessing the database. configuration specified by this method must be the same as the existing database or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>renumbering</CODE> - If true, configure the logical record numbers to be mutable, and + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>renumbering</code> - If true, configure the logical record numbers to be mutable, and change as records are added to and deleted from the database. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getRenumbering()"><!-- --></A><H3> -getRenumbering</H3> -<PRE> -public boolean <B>getRenumbering</B>()</PRE> -<DL> -<DD>Return true if the logical record numbers are mutable, and change as +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getRenumbering()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getRenumbering</h4> +<pre>public boolean getRenumbering()</pre> +<div class="block">Return true if the logical record numbers are mutable, and change as records are added to and deleted from the database. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the logical record numbers are mutable, and change as - records are added to and deleted from the database.</DL> -</DD> -</DL> -<HR> - -<A NAME="setReverseSplitOff(boolean)"><!-- --></A><H3> -setReverseSplitOff</H3> -<PRE> -public void <B>setReverseSplitOff</B>(boolean reverseSplitOff)</PRE> -<DL> -<DD>Configure the Btree to not do reverse splits. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the logical record numbers are mutable, and change as + records are added to and deleted from the database.</dd></dl> +</li> +</ul> +<a name="setReverseSplitOff(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setReverseSplitOff</h4> +<pre>public void setReverseSplitOff(boolean reverseSplitOff)</pre> +<div class="block">Configure the Btree to not do reverse splits. <p> As pages are emptied in a database, the Btree implementation attempts to coalesce empty pages into higher-level pages in order @@ -3727,47 +3092,36 @@ public void <B>setReverseSplitOff</B>(boolean reverseSplitOff)</PRE> shrunk to a minimal size can cause severe deadlocking when a new cycle of data insertion begins. <p> - Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle + Calling this method only affects the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle (and any other library handles opened within the scope of that handle). - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>reverseSplitOff</CODE> - If true, configure the Btree to not do reverse splits. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reverseSplitOff</code> - If true, configure the Btree to not do reverse splits. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getReverseSplitOff()"><!-- --></A><H3> -getReverseSplitOff</H3> -<PRE> -public boolean <B>getReverseSplitOff</B>()</PRE> -<DL> -<DD>Return true if the Btree has been configured to not do reverse splits. +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getReverseSplitOff()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReverseSplitOff</h4> +<pre>public boolean getReverseSplitOff()</pre> +<div class="block">Return true if the Btree has been configured to not do reverse splits. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the Btree has been configured to not do reverse splits.</DL> -</DD> -</DL> -<HR> - -<A NAME="setSortedDuplicates(boolean)"><!-- --></A><H3> -setSortedDuplicates</H3> -<PRE> -public void <B>setSortedDuplicates</B>(boolean sortedDuplicates)</PRE> -<DL> -<DD>Configure the database to support sorted, duplicate data items. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the Btree has been configured to not do reverse splits.</dd></dl> +</li> +</ul> +<a name="setSortedDuplicates(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSortedDuplicates</h4> +<pre>public void setSortedDuplicates(boolean sortedDuplicates)</pre> +<div class="block">Configure the database to support sorted, duplicate data items. <p> Insertion when the key of the key/data pair being inserted already exists in the database will be successful. The ordering of @@ -3790,47 +3144,36 @@ control accessing the database. configuration specified by this method must be the same as the existing database or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>sortedDuplicates</CODE> - If true, configure the database to support duplicate data items. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>sortedDuplicates</code> - If true, configure the database to support duplicate data items. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getSortedDuplicates()"><!-- --></A><H3> -getSortedDuplicates</H3> -<PRE> -public boolean <B>getSortedDuplicates</B>()</PRE> -<DL> -<DD>Return true if the database is configured to support sorted duplicate data +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getSortedDuplicates()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSortedDuplicates</h4> +<pre>public boolean getSortedDuplicates()</pre> +<div class="block">Return true if the database is configured to support sorted duplicate data items. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured to support sorted duplicate data - items.</DL> -</DD> -</DL> -<HR> - -<A NAME="setUnsortedDuplicates(boolean)"><!-- --></A><H3> -setUnsortedDuplicates</H3> -<PRE> -public void <B>setUnsortedDuplicates</B>(boolean unsortedDuplicates)</PRE> -<DL> -<DD>Configure the database to support unsorted duplicate data items. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured to support sorted duplicate data + items.</dd></dl> +</li> +</ul> +<a name="setUnsortedDuplicates(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setUnsortedDuplicates</h4> +<pre>public void setUnsortedDuplicates(boolean unsortedDuplicates)</pre> +<div class="block">Configure the database to support unsorted duplicate data items. <p> Insertion when the key of the key/data pair being inserted already exists in the database will be successful. The ordering of @@ -3852,114 +3195,86 @@ control accessing the database. configuration specified by this method must be the same as the existing database or an error will be returned. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>unsortedDuplicates</CODE> - If true, configure the database to support unsorted duplicate data items. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>unsortedDuplicates</code> - If true, configure the database to support unsorted duplicate data items. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getUnsortedDuplicates()"><!-- --></A><H3> -getUnsortedDuplicates</H3> -<PRE> -public boolean <B>getUnsortedDuplicates</B>()</PRE> -<DL> -<DD>Return true if the database is configured to support duplicate data items. +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getUnsortedDuplicates()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnsortedDuplicates</h4> +<pre>public boolean getUnsortedDuplicates()</pre> +<div class="block">Return true if the database is configured to support duplicate data items. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database is configured to support duplicate data items.</DL> -</DD> -</DL> -<HR> - -<A NAME="setSnapshot(boolean)"><!-- --></A><H3> -setSnapshot</H3> -<PRE> -public void <B>setSnapshot</B>(boolean snapshot)</PRE> -<DL> -<DD>Specify that any specified backing source file be read in its entirety +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database is configured to support duplicate data items.</dd></dl> +</li> +</ul> +<a name="setSnapshot(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setSnapshot</h4> +<pre>public void setSnapshot(boolean snapshot)</pre> +<div class="block">Specify that any specified backing source file be read in its entirety when the database is opened. <p> If this flag is not specified, the backing source file may be read lazily. <p> - Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle + Calling this method only affects the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle (and any other library handles opened within the scope of that handle). - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>snapshot</CODE> - If true, any specified backing source file will be read in its entirety + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>snapshot</code> - If true, any specified backing source file will be read in its entirety when the database is opened. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getSnapshot()"><!-- --></A><H3> -getSnapshot</H3> -<PRE> -public boolean <B>getSnapshot</B>()</PRE> -<DL> -<DD>Return true if the any specified backing source file will be read in its +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getSnapshot()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getSnapshot</h4> +<pre>public boolean getSnapshot()</pre> +<div class="block">Return true if the any specified backing source file will be read in its entirety when the database is opened. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the any specified backing source file will be read in its - entirety when the database is opened.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTransactional()"><!-- --></A><H3> -getTransactional</H3> -<PRE> -public boolean <B>getTransactional</B>()</PRE> -<DL> -<DD>Return true if the database open is enclosed within a transaction. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the any specified backing source file will be read in its + entirety when the database is opened.</dd></dl> +</li> +</ul> +<a name="getTransactional()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactional</h4> +<pre>public boolean getTransactional()</pre> +<div class="block">Return true if the database open is enclosed within a transaction. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database open is enclosed within a transaction.</DL> -</DD> -</DL> -<HR> - -<A NAME="setTransactional(boolean)"><!-- --></A><H3> -setTransactional</H3> -<PRE> -public void <B>setTransactional</B>(boolean transactional)</PRE> -<DL> -<DD>Enclose the database open within a transaction. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database open is enclosed within a transaction.</dd></dl> +</li> +</ul> +<a name="setTransactional(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactional</h4> +<pre>public void setTransactional(boolean transactional)</pre> +<div class="block">Enclose the database open within a transaction. <p> If the call succeeds, the open operation will be recoverable. If the call fails, no database will have been created. @@ -3967,23 +3282,18 @@ public void <B>setTransactional</B>(boolean transactional)</PRE> All future operations on this database, which are not explicitly enclosed in a transaction by the application, will be enclosed in in a transaction within the library. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>transactional</CODE> - If true, enclose the database open within a transaction.</DL> -</DD> -</DL> -<HR> - -<A NAME="setTransactionNotDurable(boolean)"><!-- --></A><H3> -setTransactionNotDurable</H3> -<PRE> -public void <B>setTransactionNotDurable</B>(boolean transactionNotDurable)</PRE> -<DL> -<DD>Configure the database environment to not write log records for this + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transactional</code> - If true, enclose the database open within a transaction.</dd></dl> +</li> +</ul> +<a name="setTransactionNotDurable(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTransactionNotDurable</h4> +<pre>public void setTransactionNotDurable(boolean transactionNotDurable)</pre> +<div class="block">Configure the database environment to not write log records for this database. <p> This means that updates of this database exhibit the ACI (atomicity, @@ -3995,55 +3305,44 @@ public void <B>setTransactionNotDurable</B>(boolean transactionNotDurable)< must be flushed to disk before the database handles are closed, or all database changes must be flushed from the database environment cache - using <A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A>. + using <a href="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><code>Environment.checkpoint</code></a>. <p> All database handles for a single physical file must call this method, including database handles for different databases in a physical file. <p> - Calling this method only affects the specified <A HREF="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><CODE>Database</CODE></A> handle + Calling this method only affects the specified <a href="../../../com/sleepycat/db/Database.html" title="class in com.sleepycat.db"><code>Database</code></a> handle (and any other library handles opened within the scope of that handle). - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>transactionNotDurable</CODE> - If true, configure the database environment to not write log records + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>transactionNotDurable</code> - If true, configure the database environment to not write log records for this database. A value of false is illegal to this method, that is, once set, the -configuration cannot be cleared.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTransactionNotDurable()"><!-- --></A><H3> -getTransactionNotDurable</H3> -<PRE> -public boolean <B>getTransactionNotDurable</B>()</PRE> -<DL> -<DD>Return true if the database environment is configured to not write log +configuration cannot be cleared.</dd></dl> +</li> +</ul> +<a name="getTransactionNotDurable()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTransactionNotDurable</h4> +<pre>public boolean getTransactionNotDurable()</pre> +<div class="block">Return true if the database environment is configured to not write log records for this database. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database environment is configured to not write log - records for this database.</DL> -</DD> -</DL> -<HR> - -<A NAME="setTruncate(boolean)"><!-- --></A><H3> -setTruncate</H3> -<PRE> -public void <B>setTruncate</B>(boolean truncate)</PRE> -<DL> -<DD>Configure the database to be physically truncated by truncating the +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database environment is configured to not write log + records for this database.</dd></dl> +</li> +</ul> +<a name="setTruncate(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTruncate</h4> +<pre>public void setTruncate(boolean truncate)</pre> +<div class="block">Configure the database to be physically truncated by truncating the underlying file, discarding all previous databases it might have held. <p> @@ -4054,145 +3353,130 @@ public void <B>setTruncate</B>(boolean truncate)</PRE> This configuration option cannot be lock or transaction-protected, and it is an error to specify it in a locking or transaction-protected database environment. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>truncate</CODE> - If true, configure the database to be physically truncated by truncating + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>truncate</code> - If true, configure the database to be physically truncated by truncating the underlying file, discarding all previous databases it might have - held.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTruncate()"><!-- --></A><H3> -getTruncate</H3> -<PRE> -public boolean <B>getTruncate</B>()</PRE> -<DL> -<DD>Return true if the database has been configured to be physically truncated + held.</dd></dl> +</li> +</ul> +<a name="getTruncate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getTruncate</h4> +<pre>public boolean getTruncate()</pre> +<div class="block">Return true if the database has been configured to be physically truncated by truncating the underlying file, discarding all previous databases it might have held. <p> This method may be called at any time during the life of the application. -<p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>True if the database has been configured to be physically truncated +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the database has been configured to be physically truncated by truncating the underlying file, discarding all previous databases - it might have held.</DL> -</DD> -</DL> -<HR> - -<A NAME="setType(com.sleepycat.db.DatabaseType)"><!-- --></A><H3> -setType</H3> -<PRE> -public void <B>setType</B>(<A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> type)</PRE> -<DL> -<DD>Configure the type of the database. + it might have held.</dd></dl> +</li> +</ul> +<a name="setType(com.sleepycat.db.DatabaseType)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setType</h4> +<pre>public void setType(<a href="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a> type)</pre> +<div class="block">Configure the type of the database. <p> If they type is DB_UNKNOWN, the database must already exist. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>type</CODE> - The type of the database.</DL> -</DD> -</DL> -<HR> - -<A NAME="getType()"><!-- --></A><H3> -getType</H3> -<PRE> -public <A HREF="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</A> <B>getType</B>()</PRE> -<DL> -<DD>Return the type of the database. + <p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>type</code> - The type of the database.</dd></dl> +</li> +</ul> +<a name="getType()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getType</h4> +<pre>public <a href="../../../com/sleepycat/db/DatabaseType.html" title="class in com.sleepycat.db">DatabaseType</a> getType()</pre> +<div class="block">Return the type of the database. <p> This method may be used to determine the type of the database after opening it. <p> This method may not be called before the database has been opened. - <p> -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> - -<DT><B>Returns:</B><DD>The type of the database.</DL> -</DD> -</DL> + <p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The type of the database.</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/DatabaseConfig.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/Database.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/DatabaseEntry.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/DatabaseConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="DatabaseConfig.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/DatabaseConfig.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/Database.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/DatabaseEntry.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/DatabaseConfig.html" target="_top">Frames</a></li> +<li><a href="DatabaseConfig.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> -<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> -DETAIL: <A HREF="#field_detail">FIELD</A> | <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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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> |
