diff options
author | Michi Henning <michi@zeroc.com> | 2009-06-04 16:19:02 +1000 |
---|---|---|
committer | Michi Henning <michi@zeroc.com> | 2009-06-04 16:19:02 +1000 |
commit | 45a3f61401e8c6cccc841fa43a4b35f9f5a444a8 (patch) | |
tree | 2d328e013b11a6e3724256cb471f6827c94b6e7d /java/src/Ice/ObjectReader.java | |
parent | Fixed BCC compile errors (diff) | |
download | ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.bz2 ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.tar.xz ice-45a3f61401e8c6cccc841fa43a4b35f9f5a444a8.zip |
Lots of javadoc comments.
Diffstat (limited to 'java/src/Ice/ObjectReader.java')
-rw-r--r-- | java/src/Ice/ObjectReader.java | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/java/src/Ice/ObjectReader.java b/java/src/Ice/ObjectReader.java index 04b651d0756..b26959b6219 100644 --- a/java/src/Ice/ObjectReader.java +++ b/java/src/Ice/ObjectReader.java @@ -9,8 +9,20 @@ package Ice; +/** + * Base class for extracting objects from an input stream. + **/ public abstract class ObjectReader extends ObjectImpl { + /** + * Reads the state of this Slice class from an input stream. + * + * @param in The input stream to read from. + * @param rid If <code>true</code>, extraction begins by reading a Slice type ID + * first. If <code>false</code>, the leading type ID is not read. This is used + * by the unmarshaling code in case the type ID has already been read as part + * of other unmarshaling activities. + **/ public abstract void read(InputStream in, boolean rid); public void |