1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.5.0) on Thu May 15 17:17:30 EDT 2008 --> 6<TITLE> 7CheckpointConfig (Oracle - Berkeley DB Java API) 8</TITLE> 9 10<META NAME="keywords" CONTENT="com.sleepycat.db.CheckpointConfig class"> 11 12<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../style.css" TITLE="Style"> 13 14<SCRIPT type="text/javascript"> 15function windowTitle() 16{ 17 parent.document.title="CheckpointConfig (Oracle - Berkeley DB Java API)"; 18} 19</SCRIPT> 20<NOSCRIPT> 21</NOSCRIPT> 22 23</HEAD> 24 25<BODY BGCOLOR="white" onload="windowTitle();"> 26 27 28<!-- ========= START OF TOP NAVBAR ======= --> 29<A NAME="navbar_top"><!-- --></A> 30<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 31<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 32<TR> 33<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 34<A NAME="navbar_top_firstrow"><!-- --></A> 35<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 36 <TR ALIGN="center" VALIGN="top"> 37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 38 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 39 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CheckpointConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 45 </TR> 46</TABLE> 47</TD> 48<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 49<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 50</TD> 51</TR> 52 53<TR> 54<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 55 <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 56 <A HREF="../../../com/sleepycat/db/CompactConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 57<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 58 <A HREF="../../../index.html?com/sleepycat/db/CheckpointConfig.html" target="_top"><B>FRAMES</B></A> 59 <A HREF="CheckpointConfig.html" target="_top"><B>NO FRAMES</B></A> 60 <SCRIPT type="text/javascript"> 61 <!-- 62 if(window==top) { 63 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 64 } 65 //--> 66</SCRIPT> 67<NOSCRIPT> 68 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 69</NOSCRIPT> 70 71 72</FONT></TD> 73</TR> 74<TR> 75<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 76 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 78DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 79</TR> 80</TABLE> 81<A NAME="skip-navbar_top"></A> 82<!-- ========= END OF TOP NAVBAR ========= --> 83 84<HR> 85<!-- ======== START OF CLASS DATA ======== --> 86<H2> 87<FONT SIZE="-1"> 88com.sleepycat.db</FONT> 89<BR> 90Class CheckpointConfig</H2> 91<PRE> 92<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">java.lang.Object</A> 93 <IMG SRC="../../../resources/inherit.gif" ALT="extended by "><B>com.sleepycat.db.CheckpointConfig</B> 94</PRE> 95<HR> 96<DL> 97<DT><PRE>public class <B>CheckpointConfig</B><DT>extends <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></DL> 98</PRE> 99 100<P> 101Specifies the attributes of an application invoked checkpoint operation. 102<P> 103 104<P> 105<HR> 106 107<P> 108<!-- =========== FIELD SUMMARY =========== --> 109 110<A NAME="field_summary"><!-- --></A> 111<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 112<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 113<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 114<B>Field Summary</B></FONT></TH> 115</TR> 116<TR BGCOLOR="white" CLASS="TableRowColor"> 117<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 118<CODE>static <A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A></CODE></FONT></TD> 119<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#DEFAULT">DEFAULT</A></B></CODE> 120 121<BR> 122 Default configuration used if null is passed to 123 <A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A>.</TD> 124</TR> 125</TABLE> 126 127<!-- ======== CONSTRUCTOR SUMMARY ======== --> 128 129<A NAME="constructor_summary"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133<B>Constructor Summary</B></FONT></TH> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#CheckpointConfig()">CheckpointConfig</A></B>()</CODE> 137 138<BR> 139 An instance created using the default constructor is initialized 140 with the system's default settings.</TD> 141</TR> 142</TABLE> 143 144<!-- ========== METHOD SUMMARY =========== --> 145 146<A NAME="method_summary"><!-- --></A> 147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 149<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 150<B>Method Summary</B></FONT></TH> 151</TR> 152<TR BGCOLOR="white" CLASS="TableRowColor"> 153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 154<CODE> boolean</CODE></FONT></TD> 155<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#getForce()">getForce</A></B>()</CODE> 156 157<BR> 158 Return the configuration of the checkpoint force option.</TD> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<CODE> int</CODE></FONT></TD> 163<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#getKBytes()">getKBytes</A></B>()</CODE> 164 165<BR> 166 Return the checkpoint log data threshold, in kilobytes.</TD> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170<CODE> int</CODE></FONT></TD> 171<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#getMinutes()">getMinutes</A></B>()</CODE> 172 173<BR> 174 Return the checkpoint time threshold, in minutes.</TD> 175</TR> 176<TR BGCOLOR="white" CLASS="TableRowColor"> 177<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 178<CODE> void</CODE></FONT></TD> 179<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#setForce(boolean)">setForce</A></B>(boolean force)</CODE> 180 181<BR> 182 Configure the checkpoint force option.</TD> 183</TR> 184<TR BGCOLOR="white" CLASS="TableRowColor"> 185<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 186<CODE> void</CODE></FONT></TD> 187<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#setKBytes(int)">setKBytes</A></B>(int kbytes)</CODE> 188 189<BR> 190 Configure the checkpoint log data threshold, in kilobytes.</TD> 191</TR> 192<TR BGCOLOR="white" CLASS="TableRowColor"> 193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 194<CODE> void</CODE></FONT></TD> 195<TD><CODE><B><A HREF="../../../com/sleepycat/db/CheckpointConfig.html#setMinutes(int)">setMinutes</A></B>(int minutes)</CODE> 196 197<BR> 198 Configure the checkpoint time threshold, in minutes.</TD> 199</TR> 200</TABLE> 201 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 202<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 203<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 204<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A></B></TH> 205</TR> 206<TR BGCOLOR="white" CLASS="TableRowColor"> 207<TD><CODE><A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/j2se/1.5.0/docs/api/java/lang/Object.html#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD> 208</TR> 209</TABLE> 210 211<P> 212 213<!-- ============ FIELD DETAIL =========== --> 214 215<A NAME="field_detail"><!-- --></A> 216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 218<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 219<B>Field Detail</B></FONT></TH> 220</TR> 221</TABLE> 222 223<A NAME="DEFAULT"><!-- --></A><H3> 224DEFAULT</H3> 225<PRE> 226public static final <A HREF="../../../com/sleepycat/db/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</A> <B>DEFAULT</B></PRE> 227<DL> 228<DD>Default configuration used if null is passed to 229 <A HREF="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><CODE>Environment.checkpoint</CODE></A>. 230<P> 231<DL> 232</DL> 233</DL> 234 235<!-- ========= CONSTRUCTOR DETAIL ======== --> 236 237<A NAME="constructor_detail"><!-- --></A> 238<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 239<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 240<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 241<B>Constructor Detail</B></FONT></TH> 242</TR> 243</TABLE> 244 245<A NAME="CheckpointConfig()"><!-- --></A><H3> 246CheckpointConfig</H3> 247<PRE> 248public <B>CheckpointConfig</B>()</PRE> 249<DL> 250<DD>An instance created using the default constructor is initialized 251 with the system's default settings. 252<P> 253</DL> 254 255<!-- ============ METHOD DETAIL ========== --> 256 257<A NAME="method_detail"><!-- --></A> 258<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 259<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 260<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 261<B>Method Detail</B></FONT></TH> 262</TR> 263</TABLE> 264 265<A NAME="setKBytes(int)"><!-- --></A><H3> 266setKBytes</H3> 267<PRE> 268public void <B>setKBytes</B>(int kbytes)</PRE> 269<DL> 270<DD>Configure the checkpoint log data threshold, in kilobytes. 271 <p> 272 The default is 0 for this class and the database environment. 273 <p> 274<P> 275<DD><DL> 276<DT><B>Parameters:</B><DD><CODE>kbytes</CODE> - If the kbytes parameter is non-zero, a checkpoint will be performed if more 277 than kbytes of log data have been written since the last checkpoint.</DL> 278</DD> 279</DL> 280<HR> 281 282<A NAME="getKBytes()"><!-- --></A><H3> 283getKBytes</H3> 284<PRE> 285public int <B>getKBytes</B>()</PRE> 286<DL> 287<DD>Return the checkpoint log data threshold, in kilobytes. 288<p> 289This method may be called at any time during the life of the application. 290<p> 291<P> 292<DD><DL> 293 294<DT><B>Returns:</B><DD>The checkpoint log data threshold, in kilobytes.</DL> 295</DD> 296</DL> 297<HR> 298 299<A NAME="setMinutes(int)"><!-- --></A><H3> 300setMinutes</H3> 301<PRE> 302public void <B>setMinutes</B>(int minutes)</PRE> 303<DL> 304<DD>Configure the checkpoint time threshold, in minutes. 305 <p> 306 The default is 0 for this class and the database environment. 307 <p> 308<P> 309<DD><DL> 310<DT><B>Parameters:</B><DD><CODE>minutes</CODE> - If the minutes parameter is non-zero, a checkpoint is performed if more than 311 min minutes have passed since the last checkpoint.</DL> 312</DD> 313</DL> 314<HR> 315 316<A NAME="getMinutes()"><!-- --></A><H3> 317getMinutes</H3> 318<PRE> 319public int <B>getMinutes</B>()</PRE> 320<DL> 321<DD>Return the checkpoint time threshold, in minutes. 322 <p> 323<P> 324<DD><DL> 325 326<DT><B>Returns:</B><DD>The checkpoint time threshold, in minutes.</DL> 327</DD> 328</DL> 329<HR> 330 331<A NAME="setForce(boolean)"><!-- --></A><H3> 332setForce</H3> 333<PRE> 334public void <B>setForce</B>(boolean force)</PRE> 335<DL> 336<DD>Configure the checkpoint force option. 337 <p> 338 The default is false for this class and the BDB JE environment. 339 <p> 340<P> 341<DD><DL> 342<DT><B>Parameters:</B><DD><CODE>force</CODE> - If set to true, force a checkpoint, even if there has been no 343 activity since the last checkpoint.</DL> 344</DD> 345</DL> 346<HR> 347 348<A NAME="getForce()"><!-- --></A><H3> 349getForce</H3> 350<PRE> 351public boolean <B>getForce</B>()</PRE> 352<DL> 353<DD>Return the configuration of the checkpoint force option. 354 <p> 355<P> 356<DD><DL> 357 358<DT><B>Returns:</B><DD>The configuration of the checkpoint force option.</DL> 359</DD> 360</DL> 361<!-- ========= END OF CLASS DATA ========= --> 362<HR> 363 364 365<!-- ======= START OF BOTTOM NAVBAR ====== --> 366<A NAME="navbar_bottom"><!-- --></A> 367<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 368<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 369<TR> 370<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 371<A NAME="navbar_bottom_firstrow"><!-- --></A> 372<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 373 <TR ALIGN="center" VALIGN="top"> 374 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 375 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 376 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 377 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CheckpointConfig.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 378 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 379 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 380 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 381 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 382 </TR> 383</TABLE> 384</TD> 385<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 386<b>Berkeley DB</b><br><font size="-1"> version 4.7.25</font></EM> 387</TD> 388</TR> 389 390<TR> 391<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 392 <A HREF="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A> 393 <A HREF="../../../com/sleepycat/db/CompactConfig.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD> 394<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 395 <A HREF="../../../index.html?com/sleepycat/db/CheckpointConfig.html" target="_top"><B>FRAMES</B></A> 396 <A HREF="CheckpointConfig.html" target="_top"><B>NO FRAMES</B></A> 397 <SCRIPT type="text/javascript"> 398 <!-- 399 if(window==top) { 400 document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>'); 401 } 402 //--> 403</SCRIPT> 404<NOSCRIPT> 405 <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A> 406</NOSCRIPT> 407 408 409</FONT></TD> 410</TR> 411<TR> 412<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 413 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 414<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 415DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 416</TR> 417</TABLE> 418<A NAME="skip-navbar_bottom"></A> 419<!-- ======== END OF BOTTOM NAVBAR ======= --> 420 421<HR> 422<font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font> 423</BODY> 424</HTML> 425
