summaryrefslogtreecommitdiff
path: root/libjava/java/io/OptionalDataException.java
diff options
context:
space:
mode:
authorTom Tromey <tromey@redhat.com>2002-06-15 18:59:15 +0000
committerTom Tromey <tromey@gcc.gnu.org>2002-06-15 18:59:15 +0000
commit34442f32a2407deff70df24c62713044748caf84 (patch)
tree1552fa58fe7792b5a7327cb8881602dd3ea5a4aa /libjava/java/io/OptionalDataException.java
parent945dabcd7ac1a6b7aedb28b8e192aec12c601a85 (diff)
downloadgcc-34442f32a2407deff70df24c62713044748caf84.tar.gz
BufferedOutputStream.java: Re-merged with Classpath.
* java/io/BufferedOutputStream.java: Re-merged with Classpath. * java/io/CharConversionException.java: Likewise. * java/io/EOFException.java: Likewise. * java/io/FileNotFoundException.java: Likewise. * java/io/IOException.java: Likewise. * java/io/InterruptedIOException.java: Likewise. * java/io/InvalidClassException.java: Likewise. * java/io/InvalidObjectException.java: Likewise. * java/io/NotActiveException.java: Likewise. * java/io/NotSerializableException.java: Likewise. * java/io/ObjectStreamException.java: Likewise. * java/io/ObjectStreamConstants.java: Likewise. * java/io/OptionalDataException.java: Likewise. * java/io/PipedInputStream.java: Likewise. * java/io/PushbackInputStream.java: Likewise. * java/io/StreamCorruptedException.java: Likewise. * java/io/SyncFailedException.java: Likewise. * java/io/UTFDataFormatException.java: Likewise. * java/io/UnsupportedEncodingException.java: Likewise. * java/io/WriteAbortedException.java: Likewise. From-SVN: r54655
Diffstat (limited to 'libjava/java/io/OptionalDataException.java')
-rw-r--r--libjava/java/io/OptionalDataException.java107
1 files changed, 50 insertions, 57 deletions
diff --git a/libjava/java/io/OptionalDataException.java b/libjava/java/io/OptionalDataException.java
index b369d837fea..919c2bf0f4d 100644
--- a/libjava/java/io/OptionalDataException.java
+++ b/libjava/java/io/OptionalDataException.java
@@ -1,5 +1,5 @@
-/* OptionalDataException.java -- indicates unexpected data in serialised stream
- Copyright (C) 1998, 2000, 2001 Free Software Foundation, Inc.
+/* OptionalDataException.java -- indicates unexpected data in serialized stream
+ Copyright (C) 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -7,7 +7,7 @@ GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
-
+
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
@@ -38,61 +38,54 @@ exception statement from your version. */
package java.io;
-/* Written using on-line Java Platform 1.2 API Specification.
- * Status: Believed complete and correct.
- */
-
/**
- * This exception is thrown when unexpected data appears in the input
- * stream from which a serialized object is being read. The field
- * <code>eof</code> will always be set to true (***Why even have it?***) and
- * the <code>count</code> field will contain the number of valid bytes
- * available to be read.
- *
- * @version 0.0
- *
- * @author Aaron M. Renn (arenn@urbanophile.com)
- * @author Warren Levy <warrenl@cygnus.com>
- * @date February 7, 2000.
- */
-public class OptionalDataException extends ObjectStreamException
-{
-
-private static final long serialVersionUID = -8011121865681257820L;
-
-/*
- * Instance Variables
+ * This exception is thrown when unexpected data appears in the input
+ * stream from which a serialized object is being read. There are two
+ * cases:<br><ul>
+ * <li>The next stream element is primitive data. <code>eof</code> will
+ * be false, and <code>count</code> is the number of bytes of primitive
+ * data available.</li>
+ * <li>The data consumable by readObject or readExternal has been exhausted.
+ * <code>eof</code> is true, and <code>count</code> is 0.</li>
+ * </ul>
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
+ * @author Warren Levy <warrenl@cygnus.com>
+ * @since 1.1
+ * @status updated to 1.4
*/
-
-/**
- * Whether or not the end of the stream has been reached
- */
-public boolean eof;
-
-/**
- * The number of valid bytes that can be read
- */
-public int length;
-
-/*************************************************************************/
-
-/*
- * Constructors
- */
-
-/**
- * Create a new OptionalDataException with an eof parameter indicating
- * whether or not the end of stream is reached and the number of valid
- * bytes that may be read.
- *
- * @param eof 'true' if end of stream reached, 'false' otherwise
- * @param count The number of valid bytes to be read.
- */
-OptionalDataException(boolean eof, int count)
+public class OptionalDataException extends ObjectStreamException
{
- this.eof = eof;
- this.length = count;
-}
-
+ /**
+ * Compatible with JDK 1.1+.
+ */
+ private static final long serialVersionUID = -8011121865681257820L;
+
+ /**
+ * Whether or not the end of the stream has been reached.
+ *
+ * @serial the end of the buffer was reached
+ */
+ public boolean eof;
+
+ /**
+ * The number of valid bytes that can be read.
+ *
+ * @serial the bytes of the buffer remaining
+ */
+ public int length;
+
+ /**
+ * Create a new OptionalDataException with an eof parameter indicating
+ * whether or not the end of stream is reached and the number of valid
+ * bytes that may be read.
+ *
+ * @param eof 'true' if end of stream reached, 'false' otherwise
+ * @param count The number of valid bytes to be read
+ */
+ OptionalDataException(boolean eof, int count)
+ {
+ this.eof = eof;
+ this.length = count;
+ }
} // class OptionalDataException
-