Skip to content

Commit

Permalink
Update javadocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
broneill committed Nov 15, 2024
1 parent 64e2ef9 commit c47c94e
Show file tree
Hide file tree
Showing 7 changed files with 36 additions and 24 deletions.
4 changes: 2 additions & 2 deletions docs/javadoc/index-files/index-22.html
Original file line number Diff line number Diff line change
Expand Up @@ -207,11 +207,11 @@ <h2 class="title" id="I:V">V</h2>
</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/diag/VerificationObserver.html#%3Cinit%3E()" class="member-name-link">VerificationObserver()</a> - Constructor for class org.cojen.tupl.diag.<a href="../org.cojen.tupl/org/cojen/tupl/diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a></dt>
<dd>&nbsp;</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/Database.html#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify(VerificationObserver)</a> - Method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl">Database</a></dt>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/Database.html#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify(VerificationObserver, int)</a> - Method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Database.html" title="interface in org.cojen.tupl">Database</a></dt>
<dd>
<div class="block">Verifies the integrity of the database and all indexes.</div>
</dd>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/Index.html#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify(VerificationObserver)</a> - Method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Index.html" title="interface in org.cojen.tupl">Index</a></dt>
<dt><a href="../org.cojen.tupl/org/cojen/tupl/Index.html#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify(VerificationObserver, int)</a> - Method in interface org.cojen.tupl.<a href="../org.cojen.tupl/org/cojen/tupl/Index.html" title="interface in org.cojen.tupl">Index</a></dt>
<dd>
<div class="block">Verifies the integrity of the index.</div>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion docs/javadoc/member-search-index.js

Large diffs are not rendered by default.

17 changes: 11 additions & 6 deletions docs/javadoc/org.cojen.tupl/org/cojen/tupl/Database.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@
<li><a href="#resumeCheckpoints()" tabindex="0">resumeCheckpoints()</a></li>
<li><a href="#commitLock()" tabindex="0">commitLock()</a></li>
<li><a href="#compactFile(org.cojen.tupl.diag.CompactionObserver,double)" tabindex="0">compactFile(CompactionObserver, double)</a></li>
<li><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" tabindex="0">verify(VerificationObserver)</a></li>
<li><a href="#verify(org.cojen.tupl.diag.VerificationObserver,int)" tabindex="0">verify(VerificationObserver, int)</a></li>
<li><a href="#isLeader()" tabindex="0">isLeader()</a></li>
<li><a href="#uponLeader(java.lang.Runnable,java.lang.Runnable)" tabindex="0">uponLeader(Runnable, Runnable)</a></li>
<li><a href="#failover()" tabindex="0">failover()</a></li>
Expand Down Expand Up @@ -462,7 +462,8 @@ <h2>Method Summary</h2>
become the leader.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Verifies the integrity of the database and all indexes.</div>
</div>
Expand Down Expand Up @@ -546,7 +547,7 @@ <h3>rebuild</h3>
<dt>Returns:</dt>
<dd>the newly built database</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the new database already exists</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/IllegalStateException.html" title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if the new database already exists or if either is replicated</dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
</dl>
</div>
Expand Down Expand Up @@ -1244,15 +1245,19 @@ <h3>compactFile</h3>
</section>
</li>
<li>
<section class="detail" id="verify(org.cojen.tupl.diag.VerificationObserver)">
<section class="detail" id="verify(org.cojen.tupl.diag.VerificationObserver,int)">
<h3>verify</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">verify</span><wbr><span class="parameters">(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</span>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">verify</span><wbr><span class="parameters">(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Verifies the integrity of the database and all indexes.</div>
<div class="block">Verifies the integrity of the database and all indexes. Using multiple threads speeds up
verification, even though some nodes might be visited multiple times.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>observer</code> - optional observer; pass null for default</dd>
<dd><code>numThreads</code> - pass 0 for default, or if negative, the actual number will be <code>
(-numThreads * availableProcessors)</code>.</dd>
<dt>Returns:</dt>
<dd>true if verification passed</dd>
<dt>Throws:</dt>
Expand Down
15 changes: 10 additions & 5 deletions docs/javadoc/org.cojen.tupl/org/cojen/tupl/Index.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
<li><a href="#asTable(java.lang.Class)" tabindex="0">asTable(Class)</a></li>
<li><a href="#evict(org.cojen.tupl.Transaction,byte%5B%5D,byte%5B%5D,org.cojen.tupl.Filter,boolean)" tabindex="0">evict(Transaction, byte[], byte[], Filter, boolean)</a></li>
<li><a href="#analyze(byte%5B%5D,byte%5B%5D)" tabindex="0">analyze(byte[], byte[])</a></li>
<li><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" tabindex="0">verify(VerificationObserver)</a></li>
<li><a href="#verify(org.cojen.tupl.diag.VerificationObserver,int)" tabindex="0">verify(VerificationObserver, int)</a></li>
<li><a href="#close()" tabindex="0">close()</a></li>
<li><a href="#isClosed()" tabindex="0">isClosed()</a></li>
<li><a href="#drop()" tabindex="0">drop()</a></li>
Expand Down Expand Up @@ -162,7 +162,8 @@ <h2>Method Summary</h2>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#nameString()" class="member-name-link">nameString</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify</a><wbr>(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Verifies the integrity of the index.</div>
</div>
Expand Down Expand Up @@ -291,15 +292,19 @@ <h3>analyze</h3>
</section>
</li>
<li>
<section class="detail" id="verify(org.cojen.tupl.diag.VerificationObserver)">
<section class="detail" id="verify(org.cojen.tupl.diag.VerificationObserver,int)">
<h3>verify</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">verify</span><wbr><span class="parameters">(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</span>
<div class="member-signature"><span class="return-type">boolean</span>&nbsp;<span class="element-name">verify</span><wbr><span class="parameters">(<a href="diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div>
<div class="block">Verifies the integrity of the index.</div>
<div class="block">Verifies the integrity of the index. Using multiple threads speeds up verification,
even though some nodes might be visited multiple times.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>observer</code> - optional observer; pass null for default</dd>
<dd><code>numThreads</code> - pass 0 for default, or if negative, the actual number will be <code>
(-numThreads * availableProcessors)</code>.</dd>
<dt>Returns:</dt>
<dd>true if verification passed</dd>
<dt>Throws:</dt>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -105,14 +105,14 @@ <h1 title="Class VerificationObserver" class="title">Class VerificationObserver<
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">VerificationObserver</span>
<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></span></div>
<div class="block">Index verification observer. Implementation does not need to be thread-safe, but instances
should not be shared by concurrent verifications.</div>
<div class="block">Index verification observer. Because verification can use multiple threads, a few of the
observer methods need to be thread-safe: <a href="#indexNodePassed(long,int,int,int,int)"><code>indexNodePassed</code></a> and <a href="#indexNodeFailed(long,int,java.lang.String)"><code>indexNodeFailed</code></a>.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../Database.html#verify(org.cojen.tupl.diag.VerificationObserver)"><code>Database.verify</code></a></li>
<li><a href="../Index.html#verify(org.cojen.tupl.diag.VerificationObserver)"><code>Index.verify</code></a></li>
<li><a href="../Database.html#verify(org.cojen.tupl.diag.VerificationObserver,int)"><code>Database.verify</code></a></li>
<li><a href="../Index.html#verify(org.cojen.tupl.diag.VerificationObserver,int)"><code>Index.verify</code></a></li>
</ul>
</dd>
</dl>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -82,12 +82,14 @@ <h2>Uses of <a href="../VerificationObserver.html" title="class in org.cojen.tup
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color"><code>boolean</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Database.</span><code><a href="../../Database.html#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="../VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-second even-row-color"><span class="type-name-label">Database.</span><code><a href="../../Database.html#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify</a><wbr>(<a href="../VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</code></div>
<div class="col-last even-row-color">
<div class="block">Verifies the integrity of the database and all indexes.</div>
</div>
<div class="col-first odd-row-color"><code>boolean</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Index.</span><code><a href="../../Index.html#verify(org.cojen.tupl.diag.VerificationObserver)" class="member-name-link">verify</a><wbr>(<a href="../VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer)</code></div>
<div class="col-second odd-row-color"><span class="type-name-label">Index.</span><code><a href="../../Index.html#verify(org.cojen.tupl.diag.VerificationObserver,int)" class="member-name-link">verify</a><wbr>(<a href="../VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a>&nbsp;observer,
int&nbsp;numThreads)</code></div>
<div class="col-last odd-row-color">
<div class="block">Verifies the integrity of the index.</div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/javadoc/org.cojen.tupl/org/cojen/tupl/tools/Verify.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,14 +96,14 @@ <h1 title="Class Verify" class="title">Class Verify</h1>
<hr>
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Verify</span>
<span class="extends-implements">extends <a href="../diag/VerificationObserver.html" title="class in org.cojen.tupl.diag">VerificationObserver</a></span></div>
<div class="block">Simple database verification utility. Main method requires a single argument &mdash; a base
file path for the database. An optional cache size can be provided too. Main method exits
with a status of 1 if verification failed, 0 if succeeded.</div>
<div class="block">Simple database verification utility. The main method requires a single argument &mdash; a
base file path for the database. An optional cache size can be provided too. The main method
exits with a status of 1 if verification failed, or else 0 if it succeeded.</div>
<dl class="notes">
<dt>See Also:</dt>
<dd>
<ul class="tag-list">
<li><a href="../Database.html#verify(org.cojen.tupl.diag.VerificationObserver)"><code>Database.verify</code></a></li>
<li><a href="../Database.html#verify(org.cojen.tupl.diag.VerificationObserver,int)"><code>Database.verify</code></a></li>
</ul>
</dd>
</dl>
Expand Down

0 comments on commit c47c94e

Please sign in to comment.