Update javadocs.

cojen · Jul 25, 2024 · 100d802 · 100d802
1 parent c821cd0
commit 100d802
Show file tree

Hide file tree

Showing 87 changed files with 938 additions and 545 deletions.
diff --git a/docs/javadoc/allclasses-index.html b/docs/javadoc/allclasses-index.html
diff --git a/docs/javadoc/allpackages-index.html b/docs/javadoc/allpackages-index.html
@@ -54,7 +54,7 @@ <h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color"><a href="org.cojen.tupl/org/cojen/tupl/package-summary.html">org.cojen.tupl</a></div>
 <div class="col-last even-row-color">
-<div class="block">See <a href="org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with Tupl.</div>
+<div class="block">See <a href="org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with TuplDB.</div>
 </div>
 <div class="col-first odd-row-color"><a href="org.cojen.tupl/org/cojen/tupl/diag/package-summary.html">org.cojen.tupl.diag</a></div>
 <div class="col-last odd-row-color">

diff --git a/docs/javadoc/index-files/index-15.html b/docs/javadoc/index-files/index-15.html
@@ -146,11 +146,11 @@ <h2 class="title" id="I:O">O</h2>
 </dd>
 <dt><a href="../org.cojen.tupl/module-summary.html">org.cojen.tupl</a> - module org.cojen.tupl</dt>
 <dd>
-<div class="block">See <a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with Tupl.</div>
+<div class="block">See <a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with TuplDB.</div>
 </dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/package-summary.html">org.cojen.tupl</a> - package org.cojen.tupl</dt>
 <dd>
-<div class="block">See <a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with Tupl.</div>
+<div class="block">See <a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with TuplDB.</div>
 </dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/diag/package-summary.html">org.cojen.tupl.diag</a> - package org.cojen.tupl.diag</dt>
 <dd>

diff --git a/docs/javadoc/index-files/index-19.html b/docs/javadoc/index-files/index-19.html
@@ -367,6 +367,8 @@ <h2 class="title" id="I:S">S</h2>
 <div class="block">Unconditionally stores the given row, potentially replacing a corresponding row which
  already exists.</div>
 </dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#storedChecksum()" class="member-name-link">storedChecksum()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/Query.html#streamPlan(org.cojen.tupl.Transaction,java.lang.Object...)" class="member-name-link">streamPlan(Transaction, Object...)</a> - Method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Query.html" title="interface in org.cojen.tupl">Query</a></dt>
 <dd>
 <div class="block">Returns a query plan used by <a href="../org.cojen.tupl/org/cojen/tupl/Query.html#newStream(org.cojen.tupl.Transaction,java.lang.Object...)"><code>newStream</code></a>.</div>

diff --git a/docs/javadoc/index-files/index-3.html b/docs/javadoc/index-files/index-3.html
@@ -173,6 +173,17 @@ <h2 class="title" id="I:C">C</h2>
 <dd>
 <div class="block">Checks if the given source row can be stored into the source table.</div>
 </dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" class="type-name-link" title="class in org.cojen.tupl">ChecksumException</a> - Exception Class in <a href="../org.cojen.tupl/org/cojen/tupl/package-summary.html">org.cojen.tupl</a></dt>
+<dd>
+<div class="block">Thrown when a page of data from the database is detected as being corrupt because the
+ stored checksum doesn't match what was freshly computed.</div>
+</dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#%3Cinit%3E(long,int,int)" class="member-name-link">ChecksumException(long, int, int)</a> - Constructor for exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#%3Cinit%3E(long,long,long)" class="member-name-link">ChecksumException(long, long, long)</a> - Constructor for exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#%3Cinit%3E(java.lang.String,long,long)" class="member-name-link">ChecksumException(String, long, long)</a> - Constructor for exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/DatabaseConfig.html#checksumPages(java.util.function.Supplier)" class="member-name-link">checksumPages(Supplier&lt;Checksum&gt;)</a> - Method in class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/DatabaseConfig.html" title="class in org.cojen.tupl">DatabaseConfig</a></dt>
 <dd>
 <div class="block">Enable 32-bit checksums for all of the underlying database pages.</div>
@@ -453,6 +464,8 @@ <h2 class="title" id="I:C">C</h2>
 <div class="block">Compress the underlying database pages, reducing overall size at the cost of
  performance.</div>
 </dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#computedChecksum()" class="member-name-link">computedChecksum()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/util/Latch.Condition.html#%3Cinit%3E()" class="member-name-link">Condition()</a> - Constructor for class org.cojen.tupl.util.<a href="../org.cojen.tupl/org/cojen/tupl/util/Latch.Condition.html" title="class in org.cojen.tupl.util">Latch.Condition</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/ConfirmationFailureException.html" class="type-name-link" title="class in org.cojen.tupl">ConfirmationFailureException</a> - Exception Class in <a href="../org.cojen.tupl/org/cojen/tupl/package-summary.html">org.cojen.tupl</a></dt>

diff --git a/docs/javadoc/index-files/index-9.html b/docs/javadoc/index-files/index-9.html
@@ -361,6 +361,8 @@ <h2 class="title" id="I:I">I</h2>
 <dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/CacheExhaustedException.html#isRecoverable()" class="member-name-link">isRecoverable()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/CacheExhaustedException.html" title="class in org.cojen.tupl">CacheExhaustedException</a></dt>
 <dd>&nbsp;</dd>
+<dt><a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html#isRecoverable()" class="member-name-link">isRecoverable()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ChecksumException.html" title="class in org.cojen.tupl">ChecksumException</a></dt>
+<dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/ClosedIndexException.html#isRecoverable()" class="member-name-link">isRecoverable()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ClosedIndexException.html" title="class in org.cojen.tupl">ClosedIndexException</a></dt>
 <dd>&nbsp;</dd>
 <dt><a href="../org.cojen.tupl/org/cojen/tupl/ConfirmationInterruptedException.html#isRecoverable()" class="member-name-link">isRecoverable()</a> - Method in exception class org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/ConfirmationInterruptedException.html" title="class in org.cojen.tupl">ConfirmationInterruptedException</a></dt>

diff --git a/docs/javadoc/member-search-index.js b/docs/javadoc/member-search-index.js
diff --git a/docs/javadoc/org.cojen.tupl/module-summary.html b/docs/javadoc/org.cojen.tupl/module-summary.html
@@ -72,7 +72,7 @@ <h1 title="Module org.cojen.tupl" class="title">Module org.cojen.tupl</h1>
 <div class="module-signature">module <span class="element-name">org.cojen.tupl</span></div>
 <section class="module-description" id="module-description">
 <!-- ============ MODULE DESCRIPTION =========== -->
-<div class="block">See <a href="org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with Tupl.</div>
+<div class="block">See <a href="org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with TuplDB.</div>
 </section>
 </div>
 <section class="summary">
@@ -88,7 +88,7 @@ <h2>Packages</h2>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color package-summary-table package-summary-table-tab1"><a href="org/cojen/tupl/package-summary.html">org.cojen.tupl</a></div>
 <div class="col-last even-row-color package-summary-table package-summary-table-tab1">
-<div class="block">See <a href="org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with Tupl.</div>
+<div class="block">See <a href="org/cojen/tupl/Database.html" title="interface in org.cojen.tupl"><code>Database</code></a> to get started with TuplDB.</div>
 </div>
 <div class="col-first odd-row-color package-summary-table package-summary-table-tab1"><a href="org/cojen/tupl/diag/package-summary.html">org.cojen.tupl.diag</a></div>
 <div class="col-last odd-row-color package-summary-table package-summary-table-tab1">