Skip to content

Commit

Permalink
Update javadocs.
Browse files Browse the repository at this point in the history
  • Loading branch information
broneill committed Oct 6, 2024
1 parent 9abe57b commit 3e728ea
Show file tree
Hide file tree
Showing 36 changed files with 489 additions and 489 deletions.
4 changes: 2 additions & 2 deletions docs/javadoc/index-all.html
Original file line number Diff line number Diff line change
Expand Up @@ -194,11 +194,11 @@ <h2 class="title" id="I:C">C</h2>
</dd>
<dt><a href="org.cojen.dirmi/org/cojen/dirmi/Environment.html#create()" class="member-name-link">create()</a> - Static method in interface org.cojen.dirmi.<a href="org.cojen.dirmi/org/cojen/dirmi/Environment.html" title="interface in org.cojen.dirmi">Environment</a></dt>
<dd>
<div class="block">Returns a new <code>Environment</code> instance which uses a default <a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link"><code>Executor</code></a>.</div>
<div class="block">Returns a new <code>Environment</code> instance which uses a default <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link"><code>Executor</code></a>.</div>
</dd>
<dt><a href="org.cojen.dirmi/org/cojen/dirmi/Environment.html#create(java.util.concurrent.Executor)" class="member-name-link">create(Executor)</a> - Static method in interface org.cojen.dirmi.<a href="org.cojen.dirmi/org/cojen/dirmi/Environment.html" title="interface in org.cojen.dirmi">Environment</a></dt>
<dd>
<div class="block">Returns a new <code>Environment</code> instance which uses the given <a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link"><code>Executor</code></a>.</div>
<div class="block">Returns a new <code>Environment</code> instance which uses the given <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/util/concurrent/Executor.html" title="class or interface in java.util.concurrent" class="external-link"><code>Executor</code></a>.</div>
</dd>
<dt><a href="org.cojen.dirmi/org/cojen/dirmi/Session.html#current()" class="member-name-link">current()</a> - Static method in interface org.cojen.dirmi.<a href="org.cojen.dirmi/org/cojen/dirmi/Session.html" title="interface in org.cojen.dirmi">Session</a></dt>
<dd>
Expand Down
6 changes: 3 additions & 3 deletions docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/AutoDispose.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ <h1 title="Annotation Interface AutoDispose" class="title">Annotation Interface
<section class="class-description" id="class-description">
<div class="horizontal-scroll">
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>)
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/ElementType.html#TYPE" title="class or interface in java.lang.annotation" class="external-link">TYPE</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">AutoDispose</span></div>
<div class="block">Designates a remote interface as supporting automatic disposal when the client-side object
is reclaimed by the garbage collector. Automatic disposal doesn't work for the <a href="Session.html#root()"><code>root</code></a> object, and it doesn't work when a reference cycle is formed between
Expand Down
8 changes: 4 additions & 4 deletions docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/Batched.html
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,9 @@ <h1 title="Annotation Interface Batched" class="title">Annotation Interface Batc
<section class="class-description" id="class-description">
<div class="horizontal-scroll">
<hr>
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
<div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Documented.html" title="class or interface in java.lang.annotation" class="external-link">@Documented</a>
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Retention.html" title="class or interface in java.lang.annotation" class="external-link">@Retention</a>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/RetentionPolicy.html#RUNTIME" title="class or interface in java.lang.annotation" class="external-link">RUNTIME</a>)
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/Target.html" title="class or interface in java.lang.annotation" class="external-link">@Target</a>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/annotation/ElementType.html#METHOD" title="class or interface in java.lang.annotation" class="external-link">METHOD</a>)
</span><span class="modifiers">public @interface </span><span class="element-name type-name-label">Batched</span></div>
<div class="block">Designates a remote method as being batched, which can be used to reduce transport
overhead. Method calls are sent to the remote endpoint, but the pipe isn't immediately
Expand All @@ -99,7 +99,7 @@ <h1 title="Annotation Interface Batched" class="title">Annotation Interface Batc
<p>Batched methods can declare throwing any exception, and any exception thrown by the
remote endpoint aborts the batch operation. The exception is thrown to the caller of the
method that flushed the batch. If this method does not declare throwing the proper exception
type, it's wrapped by <a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/reflect/UndeclaredThrowableException.html" title="class or interface in java.lang.reflect" class="external-link"><code>UndeclaredThrowableException</code></a>. Any <code>Remote</code> objects
type, it's wrapped by <a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/reflect/UndeclaredThrowableException.html" title="class or interface in java.lang.reflect" class="external-link"><code>UndeclaredThrowableException</code></a>. Any <code>Remote</code> objects
returned from batched method calls at or after the exception point will be disposed, and so
they should not be used.</div>
<dl class="notes">
Expand Down
14 changes: 7 additions & 7 deletions docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/ClassResolver.html
Original file line number Diff line number Diff line change
Expand Up @@ -103,8 +103,8 @@ <h2>Method Summary</h2>
<div class="table-header col-first">Modifier and Type</div>
<div class="table-header col-second">Method</div>
<div class="table-header col-last">Description</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr>&lt;?&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resolveClass(java.lang.String)" class="member-name-link">resolveClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a><wbr>&lt;?&gt;</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#resolveClass(java.lang.String)" class="member-name-link">resolveClass</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Load the class or interface for the given name.</div>
</div>
Expand All @@ -126,18 +126,18 @@ <h2>Method Details</h2>
<section class="detail" id="resolveClass(java.lang.String)">
<h3>resolveClass</h3>
<div class="horizontal-scroll">
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;</span>&nbsp;<span class="element-name">resolveClass</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a>,
<a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></span></div>
<div class="member-signature"><span class="return-type"><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/Class.html" title="class or interface in java.lang" class="external-link">Class</a>&lt;?&gt;</span>&nbsp;<span class="element-name">resolveClass</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;name)</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>,
<a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></span></div>
<div class="block">Load the class or interface for the given name. If null is returned, the default class
resolver tries to load the class. This method can be called by multiple threads
concurrently.</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>name</code> - fully qualified class name</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd>
<dd><code><a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></code></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>
<dd><code><a href="https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/ClassNotFoundException.html" title="class or interface in java.lang" class="external-link">ClassNotFoundException</a></code></dd>
</dl>
</div>
</section>
Expand Down
Loading

0 comments on commit 3e728ea

Please sign in to comment.