<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_75) on Fri May 13 13:32:15 PDT 2016 -->
<title>CheckpointConfig (Oracle - Berkeley DB Java API)</title>
<meta name="date" content="2016-05-13">
<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="CheckpointConfig (Oracle - Berkeley DB Java API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<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/CheckpointConfig.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.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/CompactConfig.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/CheckpointConfig.html" target="_top">Frames</a></li>
<li><a href="CheckpointConfig.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) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</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 ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.sleepycat.db</div>
<h2 title="Class CheckpointConfig" class="title">Class CheckpointConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.db.CheckpointConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">CheckpointConfig</span>
extends java.lang.Object</pre>
<div class="block">Specifies the attributes of an application invoked checkpoint operation.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<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/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a></code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#DEFAULT">DEFAULT</a></strong></code>
<div class="block">Default configuration used if null is passed to
<a href="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><code>Environment.checkpoint</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<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/CheckpointConfig.html#CheckpointConfig()">CheckpointConfig</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 =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#getForce()">getForce</a></strong>()</code>
<div class="block">Return the configuration of the checkpoint force option.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#getKBytes()">getKBytes</a></strong>()</code>
<div class="block">Return the checkpoint log data threshold, in kilobytes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#getMinutes()">getMinutes</a></strong>()</code>
<div class="block">Return the checkpoint time threshold, in minutes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#setForce(boolean)">setForce</a></strong>(boolean force)</code>
<div class="block">Configure the checkpoint force option.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#setKBytes(int)">setKBytes</a></strong>(int kbytes)</code>
<div class="block">Configure the checkpoint log data threshold, in kilobytes.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../com/sleepycat/db/CheckpointConfig.html#setMinutes(int)">setMinutes</a></strong>(int minutes)</code>
<div class="block">Configure the checkpoint time threshold, in minutes.</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 =========== -->
<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/CheckpointConfig.html" title="class in com.sleepycat.db">CheckpointConfig</a> DEFAULT</pre>
<div class="block">Default configuration used if null is passed to
<a href="../../../com/sleepycat/db/Environment.html#checkpoint(com.sleepycat.db.CheckpointConfig)"><code>Environment.checkpoint</code></a>.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CheckpointConfig()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CheckpointConfig</h4>
<pre>public CheckpointConfig()</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 ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setKBytes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setKBytes</h4>
<pre>public void setKBytes(int kbytes)</pre>
<div class="block">Configure the checkpoint log data threshold, in kilobytes.
<p>
The default is 0 for this class and the database environment.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>kbytes</code> - If the kbytes parameter is non-zero, a checkpoint will be performed if more
than kbytes of log data have been written since the last checkpoint.</dd></dl>
</li>
</ul>
<a name="getKBytes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getKBytes</h4>
<pre>public int getKBytes()</pre>
<div class="block">Return the checkpoint log data threshold, in kilobytes.
<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 checkpoint log data threshold, in kilobytes.</dd></dl>
</li>
</ul>
<a name="setMinutes(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMinutes</h4>
<pre>public void setMinutes(int minutes)</pre>
<div class="block">Configure the checkpoint time threshold, in minutes.
<p>
The default is 0 for this class and the database environment.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>minutes</code> - If the minutes parameter is non-zero, a checkpoint is performed if more than
min minutes have passed since the last checkpoint.</dd></dl>
</li>
</ul>
<a name="getMinutes()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMinutes</h4>
<pre>public int getMinutes()</pre>
<div class="block">Return the checkpoint time threshold, in minutes.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The checkpoint time threshold, in minutes.</dd></dl>
</li>
</ul>
<a name="setForce(boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setForce</h4>
<pre>public void setForce(boolean force)</pre>
<div class="block">Configure the checkpoint force option.
<p>
The default is false for this class and the BDB JE environment.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>force</code> - If set to true, force a checkpoint, even if there has been no
activity since the last checkpoint.</dd></dl>
</li>
</ul>
<a name="getForce()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getForce</h4>
<pre>public boolean getForce()</pre>
<div class="block">Return the configuration of the checkpoint force option.
<p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The configuration of the checkpoint force option.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><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/CheckpointConfig.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.29</font></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../com/sleepycat/db/CacheStats.html" title="class in com.sleepycat.db"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../com/sleepycat/db/CompactConfig.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/CheckpointConfig.html" target="_top">Frames</a></li>
<li><a href="CheckpointConfig.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) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</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 ======= -->
<p class="legalCopy"><small><font size=1>Copyright (c) 1996, 2016 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>
