Files
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

1067 lines
44 KiB
HTML

<!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 (11.0.7) on Mon Jun 01 06:40:53 PDT 2020 -->
<title>StoreConfig (Oracle - Berkeley DB Java API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="date" content="2020-06-01">
<link rel="stylesheet" type="text/css" href="../../../style.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
<script type="text/javascript" src="../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../jquery/jquery-3.4.1.js"></script>
<script type="text/javascript" src="../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StoreConfig (Oracle - Berkeley DB Java API)";
}
}
catch(err) {
}
//-->
var data = {"i0":10,"i1":42,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":10,"i18":10,"i19":10,"i20":10,"i21":10,"i22":10,"i23":10,"i24":10,"i25":10,"i26":10,"i27":10,"i28":10,"i29":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<div class="fixedNav">
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoreConfig.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"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">com.sleepycat.persist</a></div>
<h2 title="Class StoreConfig" class="title">Class StoreConfig</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>com.sleepycat.persist.StoreConfig</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><code>java.lang.Cloneable</code></dd>
</dl>
<hr>
<pre>public class <span class="typeNameLabel">StoreConfig</span>
extends java.lang.Object
implements java.lang.Cloneable</pre>
<div class="block">Configuration properties used with an <a href="EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a> or <a href="raw/RawStore.html" title="class in com.sleepycat.persist.raw"><code>RawStore</code></a>.
<p><code>StoreConfig</code> objects are thread-safe. Multiple threads may safely
call the methods of a shared <code>StoreConfig</code> object.</p>
<p>See the <a href="package-summary.html#example">package
summary example</a> for an example of using a <code>StoreConfig</code>.</p></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="memberSummary" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Field</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#DEFAULT">DEFAULT</a></span></code></th>
<td class="colLast">
<div class="block">The default store configuration containing properties as if the
configuration were constructed and not modified.</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="memberSummary" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Constructor</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr class="altColor">
<th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#StoreConfig--">StoreConfig</a></span>()</code></th>
<td class="colLast">
<div class="block">Creates an entity store configuration object with default properties.</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="memberSummary" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#clone--">clone</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns a shallow copy of the configuration.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#cloneConfig--">cloneConfig</a></span>()</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">As of JE 4.0.13, replaced by <a href="#clone--"><code>clone()</code></a>.</div>
</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#enableEncrypted-boolean-">enableEncrypted</a></span>&#8203;(boolean&nbsp;enable)</code></th>
<td class="colLast">
<div class="block">Enables encryption when the environment is also encrypted, see
<a href="../db/EnvironmentConfig.html#setEncrypted-java.lang.String-"><code>EnvironmentConfig.setEncrypted</code></a></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getAllowCreate--">getAllowCreate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether creation of a new store is allowed.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getDatabaseNamer--">getDatabaseNamer</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the object reponsible for naming of files and databases.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getEncrypted--">getEncrypted</a></span>()</code></th>
<td class="colLast">
<div class="block">Return true if the database has been configured to perform encryption.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getExclusiveCreate--">getExclusiveCreate</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns whether opening an existing store is prohibited.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getModel--">getModel</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the entity model that defines entity classes and index keys.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getMutations--">getMutations</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the configured mutations for performing lazy evolution of stored
instances.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getPassword--">getPassword</a></span>()</code></th>
<td class="colLast">&nbsp;</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getReadOnly--">getReadOnly</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the read-only configuration property.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getSecondaryBulkLoad--">getSecondaryBulkLoad</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the bulk-load-secondaries configuration property.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTransactional--">getTransactional</a></span>()</code></th>
<td class="colLast">
<div class="block">Returns the transactional configuration property.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowCreate-boolean-">setAllowCreate</a></span>&#8203;(boolean&nbsp;allowCreate)</code></th>
<td class="colLast">
<div class="block">Specifies whether creation of a new store is allowed.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setAllowCreateVoid-boolean-">setAllowCreateVoid</a></span>&#8203;(boolean&nbsp;allowCreate)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDatabaseNamer-com.sleepycat.persist.DatabaseNamer-">setDatabaseNamer</a></span>&#8203;(<a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a>&nbsp;databaseNamer)</code></th>
<td class="colLast">
<div class="block">Specifies the object reponsible for naming of files and databases.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDatabaseNamerVoid-com.sleepycat.persist.DatabaseNamer-">setDatabaseNamerVoid</a></span>&#8203;(<a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a>&nbsp;databaseNamer)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i17" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setEncrypted-java.lang.String-">setEncrypted</a></span>&#8203;(java.lang.String&nbsp;password)</code></th>
<td class="colLast">
<div class="block">Set the password used to perform encryption and decryption.</div>
</td>
</tr>
<tr id="i18" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExclusiveCreate-boolean-">setExclusiveCreate</a></span>&#8203;(boolean&nbsp;exclusiveCreate)</code></th>
<td class="colLast">
<div class="block">Specifies whether opening an existing store is prohibited.</div>
</td>
</tr>
<tr id="i19" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setExclusiveCreateVoid-boolean-">setExclusiveCreateVoid</a></span>&#8203;(boolean&nbsp;exclusiveCreate)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i20" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setModel-com.sleepycat.persist.model.EntityModel-">setModel</a></span>&#8203;(<a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</code></th>
<td class="colLast">
<div class="block">Sets the entity model that defines entity classes and index keys.</div>
</td>
</tr>
<tr id="i21" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setModelVoid-com.sleepycat.persist.model.EntityModel-">setModelVoid</a></span>&#8203;(<a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i22" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMutations-com.sleepycat.persist.evolve.Mutations-">setMutations</a></span>&#8203;(<a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</code></th>
<td class="colLast">
<div class="block">Configures mutations for performing lazy evolution of stored instances.</div>
</td>
</tr>
<tr id="i23" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setMutationsVoid-com.sleepycat.persist.evolve.Mutations-">setMutationsVoid</a></span>&#8203;(<a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i24" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnly-boolean-">setReadOnly</a></span>&#8203;(boolean&nbsp;readOnly)</code></th>
<td class="colLast">
<div class="block">Sets the read-only configuration property.</div>
</td>
</tr>
<tr id="i25" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setReadOnlyVoid-boolean-">setReadOnlyVoid</a></span>&#8203;(boolean&nbsp;readOnly)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i26" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecondaryBulkLoad-boolean-">setSecondaryBulkLoad</a></span>&#8203;(boolean&nbsp;secondaryBulkLoad)</code></th>
<td class="colLast">
<div class="block">Sets the bulk-load-secondaries configuration property.</div>
</td>
</tr>
<tr id="i27" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setSecondaryBulkLoadVoid-boolean-">setSecondaryBulkLoadVoid</a></span>&#8203;(boolean&nbsp;secondaryBulkLoad)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</div>
</td>
</tr>
<tr id="i28" class="altColor">
<td class="colFirst"><code><a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactional-boolean-">setTransactional</a></span>&#8203;(boolean&nbsp;transactional)</code></th>
<td class="colLast">
<div class="block">Sets the transactional configuration property.</div>
</td>
</tr>
<tr id="i29" class="rowColor">
<td class="colFirst"><code>void</code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setTransactionalVoid-boolean-">setTransactionalVoid</a></span>&#8203;(boolean&nbsp;transactional)</code></th>
<td class="colLast">
<div class="block">The void return setter for use by Bean editors.</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&nbsp;java.lang.Object</h3>
<code>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&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a> DEFAULT</pre>
<div class="block">The default store configuration containing properties as if the
configuration were constructed and not modified.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StoreConfig--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StoreConfig</h4>
<pre>public&nbsp;StoreConfig()</pre>
<div class="block">Creates an entity store configuration object with default properties.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<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 class="methodSignature">@Deprecated
public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;cloneConfig()</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">As of JE 4.0.13, replaced by <a href="#clone--"><code>clone()</code></a>.</div>
</div>
<div class="block">Returns a shallow copy of the configuration.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the clone.</dd>
</dl>
</li>
</ul>
<a name="clone--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;clone()</pre>
<div class="block">Returns a shallow copy of the configuration.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>clone</code>&nbsp;in class&nbsp;<code>java.lang.Object</code></dd>
</dl>
</li>
</ul>
<a name="setAllowCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowCreate</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setAllowCreate&#8203;(boolean&nbsp;allowCreate)</pre>
<div class="block">Specifies whether creation of a new store is allowed. By default this
property is false.
<p>If this property is false and the internal store metadata database
does not exist, <a href="../db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown when the store
is opened.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowCreate</code> - whether creation of a new store is allowed.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setAllowCreateVoid-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setAllowCreateVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setAllowCreateVoid&#8203;(boolean&nbsp;allowCreate)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowCreate</code> - whether creation of a new store is allowed.</dd>
</dl>
</li>
</ul>
<a name="getAllowCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAllowCreate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getAllowCreate()</pre>
<div class="block">Returns whether creation of a new store is allowed.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether creation of a new store is allowed.</dd>
</dl>
</li>
</ul>
<a name="setExclusiveCreate-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExclusiveCreate</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setExclusiveCreate&#8203;(boolean&nbsp;exclusiveCreate)</pre>
<div class="block">Specifies whether opening an existing store is prohibited. By default
this property is false.
<p>If this property is true and the internal store metadata database
already exists, <a href="../db/DatabaseException.html" title="class in com.sleepycat.db"><code>DatabaseException</code></a> will be thrown when the store
is opened.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exclusiveCreate</code> - whether opening an existing store is prohibited.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setExclusiveCreateVoid-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExclusiveCreateVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setExclusiveCreateVoid&#8203;(boolean&nbsp;exclusiveCreate)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>exclusiveCreate</code> - whether opening an existing store is prohibited.</dd>
</dl>
</li>
</ul>
<a name="getExclusiveCreate--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExclusiveCreate</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getExclusiveCreate()</pre>
<div class="block">Returns whether opening an existing store is prohibited.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether opening an existing store is prohibited.</dd>
</dl>
</li>
</ul>
<a name="setTransactional-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactional</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setTransactional&#8203;(boolean&nbsp;transactional)</pre>
<div class="block">Sets the transactional configuration property. By default this property
is false.
<p>This property is true to open all store indices for transactional
access. True may not be specified if the environment is not also
transactional.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transactional</code> - whether the store is transactional.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setTransactionalVoid-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTransactionalVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setTransactionalVoid&#8203;(boolean&nbsp;transactional)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>transactional</code> - whether the store is transactional.</dd>
</dl>
</li>
</ul>
<a name="getTransactional--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getTransactional</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getTransactional()</pre>
<div class="block">Returns the transactional configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is transactional.</dd>
</dl>
</li>
</ul>
<a name="setEncrypted-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setEncrypted</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setEncrypted&#8203;(java.lang.String&nbsp;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
password in a database created within an environment. To encrypt
a database within an encrypted environment use
<a href="../db/EnvironmentConfig.html#setEncrypted-java.lang.String-"><code>EnvironmentConfig.setEncrypted</code></a>
<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.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>password</code> - the password used to perform encryption and decryption</dd>
</dl>
</li>
</ul>
<a name="enableEncrypted-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>enableEncrypted</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;enableEncrypted&#8203;(boolean&nbsp;enable)</pre>
<div class="block">Enables encryption when the environment is also encrypted, see
<a href="../db/EnvironmentConfig.html#setEncrypted-java.lang.String-"><code>EnvironmentConfig.setEncrypted</code></a>
<p>
To encrypt a database that does not use an environment, see
<a href="#setEncrypted-java.lang.String-"><code>StoreConfig.setEncrypted</code></a></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>enable</code> - encryption on this database.</dd>
</dl>
</li>
</ul>
<a name="getEncrypted--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEncrypted</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;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></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>True if the database has been configured to perform encryption.</dd>
</dl>
</li>
</ul>
<a name="setReadOnly-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadOnly</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setReadOnly&#8203;(boolean&nbsp;readOnly)</pre>
<div class="block">Sets the read-only configuration property. By default this property is
false.
<p>This property is true to open all store indices for read-only access,
or false to open them for read-write access. False may not be specified
if the environment is read-only.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readOnly</code> - whether the store is read-only.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setReadOnlyVoid-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setReadOnlyVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setReadOnlyVoid&#8203;(boolean&nbsp;readOnly)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>readOnly</code> - whether the store is read-only.</dd>
</dl>
</li>
</ul>
<a name="getReadOnly--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getReadOnly</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getReadOnly()</pre>
<div class="block">Returns the read-only configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether the store is read-only.</dd>
</dl>
</li>
</ul>
<a name="setSecondaryBulkLoad-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecondaryBulkLoad</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setSecondaryBulkLoad&#8203;(boolean&nbsp;secondaryBulkLoad)</pre>
<div class="block">Sets the bulk-load-secondaries configuration property. By default this
property is false.
<p>This property is true to cause the initial creation of secondary
indices to be performed as a bulk load. If this property is true and
<a href="EntityStore.html#getSecondaryIndex-com.sleepycat.persist.PrimaryIndex-java.lang.Class-java.lang.String-"><code>EntityStore.getSecondaryIndex</code></a> has
never been called for a secondary index, that secondary index will not
be created or written as records are written to the primary index. In
addition, if that secondary index defines a foreign key constraint, the
constraint will not be enforced.</p>
<p>The secondary index will be populated later when the <code>
getSecondaryIndex</code> method is called for the first time for that index,
or when the store is closed and re-opened with this property set to
false and the primary index is obtained. In either case, the secondary
index is populated by reading through the entire primary index and
adding records to the secondary index as needed. While populating the
secondary, foreign key constraints will be enforced and an exception is
thrown if a constraint is violated.</p>
<p>When loading a primary index along with secondary indexes from a
large input data set, configuring a bulk load of the secondary indexes
is sometimes more performant than updating the secondary indexes each
time the primary index is updated. The absence of foreign key
constraints during the load also provides more flexibility.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>secondaryBulkLoad</code> - whether bulk-load-secondaries is used.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setSecondaryBulkLoadVoid-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSecondaryBulkLoadVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setSecondaryBulkLoadVoid&#8203;(boolean&nbsp;secondaryBulkLoad)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>secondaryBulkLoad</code> - whether bulk-load-secondaries is used.</dd>
</dl>
</li>
</ul>
<a name="getSecondaryBulkLoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSecondaryBulkLoad</h4>
<pre class="methodSignature">public&nbsp;boolean&nbsp;getSecondaryBulkLoad()</pre>
<div class="block">Returns the bulk-load-secondaries configuration property.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>whether bulk-load-secondaries is used.</dd>
</dl>
</li>
</ul>
<a name="setModel-com.sleepycat.persist.model.EntityModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModel</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setModel&#8203;(<a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</pre>
<div class="block">Sets the entity model that defines entity classes and index keys.
<p>If null is specified or this method is not called, an <a href="model/AnnotationModel.html" title="class in com.sleepycat.persist.model"><code>AnnotationModel</code></a> instance is used by default.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>model</code> - the EntityModel.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setModelVoid-com.sleepycat.persist.model.EntityModel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setModelVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setModelVoid&#8203;(<a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;model)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>model</code> - the EntityModel.</dd>
</dl>
</li>
</ul>
<a name="getModel--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getModel</h4>
<pre class="methodSignature">public&nbsp;<a href="model/EntityModel.html" title="class in com.sleepycat.persist.model">EntityModel</a>&nbsp;getModel()</pre>
<div class="block">Returns the entity model that defines entity classes and index keys.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the EntityModel.</dd>
</dl>
</li>
</ul>
<a name="setMutations-com.sleepycat.persist.evolve.Mutations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMutations</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setMutations&#8203;(<a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</pre>
<div class="block">Configures mutations for performing lazy evolution of stored instances.
Existing mutations for this store are not cleared, so the mutations
required are only those changes that have been made since the store was
last opened. Some new mutations may override existing specifications,
and some may be supplemental.
<p>If null is specified and the store already exists, the previously
specified mutations are used. The mutations are stored persistently in
serialized form.</p>
<p>Mutations must be available to handle all changes to classes that are
incompatible with the class definitions known to this store. See <a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve"><code>Mutations</code></a> and <a href="evolve/package-summary.html"><code>Class Evolution</code></a> for
more information.</p>
<p>If an incompatible class change has been made and mutations are not
available for handling the change, <a href="evolve/IncompatibleClassException.html" title="class in com.sleepycat.persist.evolve"><code>IncompatibleClassException</code></a>
will be thrown when creating an <a href="EntityStore.html" title="class in com.sleepycat.persist"><code>EntityStore</code></a>.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mutations</code> - the Mutations.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
</dl>
</li>
</ul>
<a name="setMutationsVoid-com.sleepycat.persist.evolve.Mutations-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setMutationsVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setMutationsVoid&#8203;(<a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;mutations)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>mutations</code> - the Mutations.</dd>
</dl>
</li>
</ul>
<a name="getMutations--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMutations</h4>
<pre class="methodSignature">public&nbsp;<a href="evolve/Mutations.html" title="class in com.sleepycat.persist.evolve">Mutations</a>&nbsp;getMutations()</pre>
<div class="block">Returns the configured mutations for performing lazy evolution of stored
instances.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the Mutations.</dd>
</dl>
</li>
</ul>
<a name="setDatabaseNamer-com.sleepycat.persist.DatabaseNamer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatabaseNamer</h4>
<pre class="methodSignature">public&nbsp;<a href="StoreConfig.html" title="class in com.sleepycat.persist">StoreConfig</a>&nbsp;setDatabaseNamer&#8203;(<a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a>&nbsp;databaseNamer)</pre>
<div class="block">Specifies the object reponsible for naming of files and databases.
By default this property is <a href="DatabaseNamer.html#DEFAULT"><code>DatabaseNamer.DEFAULT</code></a>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>databaseNamer</code> - the DatabaseNamer.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>'this'.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if a null parameter value is passed.</dd>
</dl>
</li>
</ul>
<a name="setDatabaseNamerVoid-com.sleepycat.persist.DatabaseNamer-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDatabaseNamerVoid</h4>
<pre class="methodSignature">public&nbsp;void&nbsp;setDatabaseNamerVoid&#8203;(<a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a>&nbsp;databaseNamer)</pre>
<div class="block">The void return setter for use by Bean editors.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>databaseNamer</code> - the DatabaseNamer.</dd>
</dl>
</li>
</ul>
<a name="getDatabaseNamer--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getDatabaseNamer</h4>
<pre class="methodSignature">public&nbsp;<a href="DatabaseNamer.html" title="interface in com.sleepycat.persist">DatabaseNamer</a>&nbsp;getDatabaseNamer()</pre>
<div class="block">Returns the object reponsible for naming of files and databases.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the DatabaseNamer.</dd>
</dl>
</li>
</ul>
<a name="getPassword--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getPassword</h4>
<pre class="methodSignature">public&nbsp;java.lang.String&nbsp;getPassword()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/StoreConfig.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"><b>Berkeley DB</b><br><font size="-1"> version 18.1.40</font></div>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses.html">All&nbsp;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>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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, 2020 Oracle and/or its affiliates. All rights reserved.</font></small></p>
</body>
</html>