summaryrefslogtreecommitdiff
path: root/java/src/Ice/ObjectInputStream.java
diff options
context:
space:
mode:
authorMichi Henning <michi@zeroc.com>2009-06-04 16:19:02 +1000
committerMichi Henning <michi@zeroc.com>2009-06-04 16:19:02 +1000
commit45a3f61401e8c6cccc841fa43a4b35f9f5a444a8 (patch)
tree2d328e013b11a6e3724256cb471f6827c94b6e7d /java/src/Ice/ObjectInputStream.java
parentFixed BCC compile errors (diff)
downloadice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.bz2
ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.xz
ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.zip
Lots of javadoc comments.
Diffstat (limited to 'java/src/Ice/ObjectInputStream.java')
-rw-r--r--java/src/Ice/ObjectInputStream.java19
1 files changed, 14 insertions, 5 deletions
diff --git a/java/src/Ice/ObjectInputStream.java b/java/src/Ice/ObjectInputStream.java
index f8e5ce11762..409f7781520 100644
--- a/java/src/Ice/ObjectInputStream.java
+++ b/java/src/Ice/ObjectInputStream.java
@@ -9,13 +9,19 @@
package Ice;
-//
-// If you are attempting to deserialize a Slice type that includes a
-// proxy, you must instantiate (or subclass) Ice.ObjectInputStream and
-// supply a communicator for use in reconstructing the proxy.
-//
+/**
+ * For desrialization of Slice types that contain a proxy, the application
+ * must instantiate (of subclass) <code>ObjectInputStream</code> and supply
+ * a communicator that is used to reconstruct the proxy.
+ **/
public class ObjectInputStream extends java.io.ObjectInputStream
{
+ /**
+ * Instantiates this class for the specified communicator and input stream.
+ *
+ * @param communicator The communicator to use to deserialize proxies.
+ * @param stream The input stream to read from.
+ **/
public
ObjectInputStream(Communicator communicator, java.io.InputStream stream)
throws java.io.IOException
@@ -24,6 +30,9 @@ public class ObjectInputStream extends java.io.ObjectInputStream
_communicator = communicator;
}
+ /**
+ * Returns the communicator for this stream.
+ **/
public Communicator
getCommunicator()
{