Skip to content

Commit 20ce102

Browse files
committed
Document RMI compatibility.
1 parent 27184d3 commit 20ce102

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/Remote.html

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,9 @@ <h1 title="Interface Remote" class="title">Interface Remote</h1>
8888
<div class="horizontal-scroll">
8989
<hr>
9090
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">Remote</span></div>
91-
<div class="block">Marker for designating a remote interface.</div>
91+
<div class="block">Marker for designating a remote interface.
92+
93+
<p>Note: For compatibility with interfaces designed for use with Java RMI, <a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.rmi/java/rmi/Remote.html" title="class or interface in java.rmi" class="external-link"><code>java.rmi.Remote</code></a> can also be used.</div>
9294
</div>
9395
</section>
9496
<!-- ========= END OF CLASS DATA ========= -->

docs/javadoc/org.cojen.dirmi/org/cojen/dirmi/RemoteException.html

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,11 @@ <h1 title="Class RemoteException" class="title">Class RemoteException</h1>
106106
<hr>
107107
<div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RemoteException</span>
108108
<span class="extends-implements">extends <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></span></div>
109-
<div class="block">Defines the default exception for indicating a remote call failure.</div>
109+
<div class="block">Defines the default exception for indicating a remote call failure.
110+
111+
<p>Note: For compatibility with interfaces designed for use with Java RMI, remote methods
112+
can declare throwing <a href="https://docs.oracle.com/en/java/javase/22/docs/api/java.rmi/java/rmi/RemoteException.html" title="class or interface in java.rmi" class="external-link"><code>java.rmi.RemoteException</code></a>, but none of
113+
its specialized subclasses will be used.</div>
110114
<dl class="notes">
111115
<dt>See Also:</dt>
112116
<dd>

src/main/java/org/cojen/dirmi/Remote.java

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@
1919
/**
2020
* Marker for designating a remote interface.
2121
*
22+
* <p>Note: For compatibility with interfaces designed for use with Java RMI, {@link
23+
* java.rmi.Remote java.rmi.Remote} can also be used.
24+
*
2225
* @author Brian S O'Neill
2326
*/
2427
public interface Remote {

src/main/java/org/cojen/dirmi/RemoteException.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@
2323
/**
2424
* Defines the default exception for indicating a remote call failure.
2525
*
26+
* <p>Note: For compatibility with interfaces designed for use with Java RMI, remote methods
27+
* can declare throwing {@link java.rmi.RemoteException java.rmi.RemoteException}, but none of
28+
* its specialized subclasses will be used.
29+
*
2630
* @author Brian S O'Neill
2731
* @see RemoteFailure
2832
*/

0 commit comments

Comments
 (0)