diff options
| author | Aaron M. Renn <arenn@urbanophile.com> | 2003-04-07 12:25:08 +0000 |
|---|---|---|
| committer | Michael Koch <mkoch@gcc.gnu.org> | 2003-04-07 12:25:08 +0000 |
| commit | 30da09694b77a86b0790f9480cf934120c5258d3 (patch) | |
| tree | ec6278305260bb163e480ed061dd389a1ff6db28 /libjava/java/io/ObjectInput.java | |
| parent | d5019ba399334c5064315c9d25d1e4e7bed83b77 (diff) | |
| download | gcc-30da09694b77a86b0790f9480cf934120c5258d3.zip gcc-30da09694b77a86b0790f9480cf934120c5258d3.tar.gz gcc-30da09694b77a86b0790f9480cf934120c5258d3.tar.bz2 | |
2003-04-07 Aaron M. Renn (arenn@urbanophile.com)
* java/io/ObjectStreamException
* java/io/FileFilter
* java/io/FilenameFilter
* java/io/ObjectInput
* java/io/ObjectOutput
* java/io/ObjectStreamConstants
Minor doc fixes, format fixes, spelling corrections, etc.
* java/io/DataInput
Corrected code samples in Javadocs to match reality
* java/io/DataOutput
* java/io/ObjectInputValidation
Major documentation fixes - all Javadocs re-written or updated
From-SVN: r65329
Diffstat (limited to 'libjava/java/io/ObjectInput.java')
| -rw-r--r-- | libjava/java/io/ObjectInput.java | 19 |
1 files changed, 11 insertions, 8 deletions
diff --git a/libjava/java/io/ObjectInput.java b/libjava/java/io/ObjectInput.java index 831203a..44cfb93 100644 --- a/libjava/java/io/ObjectInput.java +++ b/libjava/java/io/ObjectInput.java @@ -45,6 +45,8 @@ package java.io; * <code>InputStream</code> * * @author Aaron M. Renn (arenn@urbanophile.com) + * + * @see DataInput */ public interface ObjectInput extends DataInput { @@ -60,7 +62,8 @@ public interface ObjectInput extends DataInput /** * This method reading a byte of data from a stream. It returns that byte - * as an int. This method blocks if no data is available to be read. + * as an <code>int</code>. This method blocks if no data is available + * to be read. * * @return The byte of data read * @@ -76,7 +79,7 @@ public interface ObjectInput extends DataInput * * @param buf The byte array to receive the data read * - * @return The actual number fo bytes read or -1 if end of stream + * @return The actual number of bytes read or -1 if end of stream * * @exception IOException If an error occurs */ @@ -92,10 +95,10 @@ public interface ObjectInput extends DataInput * possible. * * @param buf The byte array to receive the data read - * @param offset The offset into @code{buf} to start storing data + * @param offset The offset into <code>buf</code> to start storing data * @param len The maximum number of bytes to read * - * @return The actual number fo bytes read or -1 if end of stream + * @return The actual number of bytes read or -1 if end of stream * * @exception IOException If an error occurs */ @@ -103,14 +106,14 @@ public interface ObjectInput extends DataInput /** * Reads an object instance and returns it. If the class for the object - * being read cannot be found, then a ClassNotFoundException will - * be thrown. + * being read cannot be found, then a <code>ClassNotFoundException</code> + * will be thrown. * * @return The object instance that was read * * @exception ClassNotFoundException If a class for the object cannot be * found - * @exception IOException If an error occurs + * @exception IOException If any other error occurs */ public abstract Object readObject() throws ClassNotFoundException, IOException; @@ -126,7 +129,7 @@ public interface ObjectInput extends DataInput * * @exception IOException If an error occurs */ - public abstract long skip(long num_bytes) throws IOException; + public abstract long skip(long numBytes) throws IOException; /** * This method closes the input source |