diff options
Diffstat (limited to 'docs/java/com/sleepycat/db/CompactConfig.html')
| -rw-r--r-- | docs/java/com/sleepycat/db/CompactConfig.html | 973 |
1 files changed, 456 insertions, 517 deletions
diff --git a/docs/java/com/sleepycat/db/CompactConfig.html b/docs/java/com/sleepycat/db/CompactConfig.html index 74c68194..41884c37 100644 --- a/docs/java/com/sleepycat/db/CompactConfig.html +++ b/docs/java/com/sleepycat/db/CompactConfig.html @@ -1,389 +1,354 @@ <!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:03 EDT 2012 --> -<TITLE> -CompactConfig (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:52 EST 2015 --> +<title>CompactConfig (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="CompactConfig (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/CompactConfig.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/CheckpointConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/CompactStats.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/CompactConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="CompactConfig.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/CompactConfig.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/CheckpointConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/CompactStats.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/CompactConfig.html" target="_top">Frames</a></li> +<li><a href="CompactConfig.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 CompactConfig</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.CompactConfig</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> -<HR> -<DL> -<DT><PRE>public class <B>CompactConfig</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> -Configuration for <A HREF="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)"><CODE>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</CODE></A> operations. -<P> - -<P> -<HR> - -<P> +<div class="header"> +<div class="subTitle">com.sleepycat.db</div> +<h2 title="Class CompactConfig" class="title">Class CompactConfig</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li>java.lang.Object</li> +<li> +<ul class="inheritance"> +<li>com.sleepycat.db.CompactConfig</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> +<hr> +<br> +<pre>public class <span class="strong">CompactConfig</span> +extends java.lang.Object +implements java.lang.Cloneable</pre> +<div class="block">Configuration for <a href="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.CompactConfig)"><code>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</code></a> operations.</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/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</A></CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#DEFAULT">DEFAULT</A></B></CODE> - -<BR> - Default configuration used if null is passed to methods that create a - cursor.</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/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</a></code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#DEFAULT">DEFAULT</a></strong></code> +<div class="block">Default configuration used if null is passed to methods that create a + cursor.</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/CompactConfig.html#CompactConfig()">CompactConfig</A></B>()</CODE> - -<BR> - Construct a default configuration object for compact operations.</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/CompactConfig.html#CompactConfig()">CompactConfig</a></strong>()</code> +<div class="block">Construct a default configuration object for compact operations.</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> int</CODE></FONT></TD> -<TD><CODE><B><A HREF="../../../com/sleepycat/db/CompactConfig.html#getFillPercent()">getFillPercent</A></B>()</CODE> - -<BR> - Return the the desired fill percentage.</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/CompactConfig.html#getFreeListOnly()">getFreeListOnly</A></B>()</CODE> - -<BR> - Return true if the whether to skip page compaction.</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/CompactConfig.html#getFreeSpace()">getFreeSpace</A></B>()</CODE> - -<BR> - Return true if the whether to return pages to the filesystem.</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/CompactConfig.html#getMaxPages()">getMaxPages</A></B>()</CODE> - -<BR> - Return the the maximum number of pages to free.</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/CompactConfig.html#getTimeout()">getTimeout</A></B>()</CODE> - -<BR> - Return the the lock timeout set for implicit transactions, in microseconds.</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/CompactConfig.html#setFillPercent(int)">setFillPercent</A></B>(int fillpercent)</CODE> - -<BR> - Set the desired fill percentage.</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/CompactConfig.html#setFreeListOnly(boolean)">setFreeListOnly</A></B>(boolean freeListOnly)</CODE> - -<BR> - Configure whether to skip page compaction, only returning pages - to the filesystem that are already free and at the end of the file.</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/CompactConfig.html#setFreeSpace(boolean)">setFreeSpace</A></B>(boolean freeSpace)</CODE> - -<BR> - Return pages to the filesystem if possible.</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/CompactConfig.html#setMaxPages(int)">setMaxPages</A></B>(int maxPages)</CODE> - -<BR> - Set the maximum number of pages to free.</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/CompactConfig.html#setTimeout(int)">setTimeout</A></B>(int timeout)</CODE> - -<BR> - Set the lock timeout for implicit transactions.</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> - +<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>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#getFillPercent()">getFillPercent</a></strong>()</code> +<div class="block">Return the the desired fill percentage.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#getFreeListOnly()">getFreeListOnly</a></strong>()</code> +<div class="block">Return true if the whether to skip page compaction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#getFreeSpace()">getFreeSpace</a></strong>()</code> +<div class="block">Return true if the whether to return pages to the filesystem.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#getMaxPages()">getMaxPages</a></strong>()</code> +<div class="block">Return the the maximum number of pages to free.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#getTimeout()">getTimeout</a></strong>()</code> +<div class="block">Return the the lock timeout set for implicit transactions, in microseconds.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#setFillPercent(int)">setFillPercent</a></strong>(int fillpercent)</code> +<div class="block">Set the desired fill percentage.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#setFreeListOnly(boolean)">setFreeListOnly</a></strong>(boolean freeListOnly)</code> +<div class="block">Configure whether to skip page compaction, only returning pages + to the filesystem that are already free and at the end of the file.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#setFreeSpace(boolean)">setFreeSpace</a></strong>(boolean freeSpace)</code> +<div class="block">Return pages to the filesystem if possible.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#setMaxPages(int)">setMaxPages</a></strong>(int maxPages)</code> +<div class="block">Set the maximum number of pages to free.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CompactConfig.html#setTimeout(int)">setTimeout</a></strong>(int timeout)</code> +<div class="block">Set the lock timeout for implicit transactions.</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/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</A> <B>DEFAULT</B></PRE> -<DL> -<DD>Default configuration used if null is passed to methods that create a - cursor. -<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/CompactConfig.html" title="class in com.sleepycat.db">CompactConfig</a> DEFAULT</pre> +<div class="block">Default configuration used if null is passed to methods that create a + cursor.</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="CompactConfig()"><!-- --></A><H3> -CompactConfig</H3> -<PRE> -public <B>CompactConfig</B>()</PRE> -<DL> -<DD>Construct a default configuration object for compact operations. -<P> -</DL> - +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="CompactConfig()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>CompactConfig</h4> +<pre>public CompactConfig()</pre> +<div class="block">Construct a default configuration object for compact operations.</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="setFillPercent(int)"><!-- --></A><H3> -setFillPercent</H3> -<PRE> -public void <B>setFillPercent</B>(int fillpercent)</PRE> -<DL> -<DD>Set the desired fill percentage. +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="setFillPercent(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFillPercent</h4> +<pre>public void setFillPercent(int fillpercent)</pre> +<div class="block">Set the desired fill percentage. If non-zero, the goal for filling pages, specified as a percentage between 1 and 100. Any page in a Btree or Recno databases not at or above this percentage full will be considered for compaction. The default behavior is to consider every page for compaction, regardless - of its page fill percentage. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>fillpercent</CODE> - The desired fill percentage.</DL> -</DD> -</DL> -<HR> - -<A NAME="getFillPercent()"><!-- --></A><H3> -getFillPercent</H3> -<PRE> -public int <B>getFillPercent</B>()</PRE> -<DL> -<DD>Return the the desired fill percentage. + of its page fill percentage.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>fillpercent</code> - The desired fill percentage.</dd></dl> +</li> +</ul> +<a name="getFillPercent()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFillPercent</h4> +<pre>public int getFillPercent()</pre> +<div class="block">Return the the desired fill percentage. <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 desired fill percentage.</DL> -</DD> -</DL> -<HR> - -<A NAME="setFreeListOnly(boolean)"><!-- --></A><H3> -setFreeListOnly</H3> -<PRE> -public void <B>setFreeListOnly</B>(boolean freeListOnly)</PRE> -<DL> -<DD>Configure whether to skip page compaction, only returning pages +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The the desired fill percentage.</dd></dl> +</li> +</ul> +<a name="setFreeListOnly(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFreeListOnly</h4> +<pre>public void setFreeListOnly(boolean freeListOnly)</pre> +<div class="block">Configure whether to skip page compaction, only returning pages to the filesystem that are already free and at the end of the file. - This flag must be set if the database is a Hash access method database. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>freeListOnly</CODE> - Whether to skip page compaction</DL> -</DD> -</DL> -<HR> - -<A NAME="getFreeListOnly()"><!-- --></A><H3> -getFreeListOnly</H3> -<PRE> -public boolean <B>getFreeListOnly</B>()</PRE> -<DL> -<DD>Return true if the whether to skip page compaction. + This flag must be set if the database is a Hash access method database.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>freeListOnly</code> - Whether to skip page compaction</dd></dl> +</li> +</ul> +<a name="getFreeListOnly()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFreeListOnly</h4> +<pre>public boolean getFreeListOnly()</pre> +<div class="block">Return true if the whether to skip page compaction. <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 whether to skip page compaction.</DL> -</DD> -</DL> -<HR> - -<A NAME="setFreeSpace(boolean)"><!-- --></A><H3> -setFreeSpace</H3> -<PRE> -public void <B>setFreeSpace</B>(boolean freeSpace)</PRE> -<DL> -<DD>Return pages to the filesystem if possible. If this flag is not +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the whether to skip page compaction.</dd></dl> +</li> +</ul> +<a name="setFreeSpace(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setFreeSpace</h4> +<pre>public void setFreeSpace(boolean freeSpace)</pre> +<div class="block">Return pages to the filesystem if possible. If this flag is not specified, pages emptied as a result of compaction will be placed on the free list for re-use, but not returned to the filesystem. Note that only pages at the end of the file may be returned. Given the one @@ -391,172 +356,146 @@ public void <B>setFreeSpace</B>(boolean freeSpace)</PRE> logically near the begining of the btree it will inhibit returning pages to the file system. A second call to the method with a low fillfactor can be used to return - pages in such a situation. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>freeSpace</CODE> - Whether to return pages to the filesystem</DL> -</DD> -</DL> -<HR> - -<A NAME="getFreeSpace()"><!-- --></A><H3> -getFreeSpace</H3> -<PRE> -public boolean <B>getFreeSpace</B>()</PRE> -<DL> -<DD>Return true if the whether to return pages to the filesystem. + pages in such a situation.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>freeSpace</code> - Whether to return pages to the filesystem</dd></dl> +</li> +</ul> +<a name="getFreeSpace()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getFreeSpace</h4> +<pre>public boolean getFreeSpace()</pre> +<div class="block">Return true if the whether to return pages to the filesystem. <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 whether to return pages to the filesystem.</DL> -</DD> -</DL> -<HR> - -<A NAME="setMaxPages(int)"><!-- --></A><H3> -setMaxPages</H3> -<PRE> -public void <B>setMaxPages</B>(int maxPages)</PRE> -<DL> -<DD>Set the maximum number of pages to free. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>maxPages</CODE> - If non-zero, the call will return after that number of pages have been - freed.</DL> -</DD> -</DL> -<HR> - -<A NAME="getMaxPages()"><!-- --></A><H3> -getMaxPages</H3> -<PRE> -public int <B>getMaxPages</B>()</PRE> -<DL> -<DD>Return the the maximum number of pages to free. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>True if the whether to return pages to the filesystem.</dd></dl> +</li> +</ul> +<a name="setMaxPages(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setMaxPages</h4> +<pre>public void setMaxPages(int maxPages)</pre> +<div class="block">Set the maximum number of pages to free.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>maxPages</code> - If non-zero, the call will return after that number of pages have been + freed.</dd></dl> +</li> +</ul> +<a name="getMaxPages()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getMaxPages</h4> +<pre>public int getMaxPages()</pre> +<div class="block">Return the the maximum number of pages to free. <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 maximum number of pages to free.</DL> -</DD> -</DL> -<HR> - -<A NAME="setTimeout(int)"><!-- --></A><H3> -setTimeout</H3> -<PRE> -public void <B>setTimeout</B>(int timeout)</PRE> -<DL> -<DD>Set the lock timeout for implicit transactions. +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The the maximum number of pages to free.</dd></dl> +</li> +</ul> +<a name="setTimeout(int)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setTimeout</h4> +<pre>public void setTimeout(int timeout)</pre> +<div class="block">Set the lock timeout for implicit transactions. If non-zero, and no transaction parameter was specified to - <A HREF="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)"><CODE>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</CODE></A>, the lock timeout set for implicit - transactions, in microseconds. -<P> -<DD><DL> -</DL> -</DD> -<DD><DL> -<DT><B>Parameters:</B><DD><CODE>timeout</CODE> - the lock timeout set for implicit transactions, in microseconds.</DL> -</DD> -</DL> -<HR> - -<A NAME="getTimeout()"><!-- --></A><H3> -getTimeout</H3> -<PRE> -public int <B>getTimeout</B>()</PRE> -<DL> -<DD>Return the the lock timeout set for implicit transactions, in microseconds. + <a href="../../../com/sleepycat/db/Database.html#compact(com.sleepycat.db.Transaction,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.DatabaseEntry,%20com.sleepycat.db.CompactConfig)"><code>Database.compact(com.sleepycat.db.Transaction, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.DatabaseEntry, com.sleepycat.db.CompactConfig)</code></a>, the lock timeout set for implicit + transactions, in microseconds.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - the lock timeout set for implicit transactions, in microseconds.</dd></dl> +</li> +</ul> +<a name="getTimeout()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getTimeout</h4> +<pre>public int getTimeout()</pre> +<div class="block">Return the the lock timeout set for implicit transactions, in microseconds. <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 lock timeout set for implicit transactions, in microseconds.</DL> -</DD> -</DL> +<p></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The the lock timeout set for implicit transactions, in microseconds.</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/CompactConfig.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/CheckpointConfig.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> - <A HREF="../../../com/sleepycat/db/CompactStats.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/CompactConfig.html" target="_top"><B>FRAMES</B></A> - <A HREF="CompactConfig.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/CompactConfig.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/CheckpointConfig.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../com/sleepycat/db/CompactStats.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/CompactConfig.html" target="_top">Frames</a></li> +<li><a href="CompactConfig.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> |