summaryrefslogtreecommitdiff
path: root/libjava/java/io/Externalizable.java
diff options
context:
space:
mode:
authorMichael Koch <konqueror@gmx.de>2003-03-23 19:11:19 +0000
committerMichael Koch <mkoch@gcc.gnu.org>2003-03-23 19:11:19 +0000
commit93b3986a7fd5c8e4de2e4c0479e9c4e3866104b0 (patch)
treeefabea7956e26714f1be960193c07e0ff3930246 /libjava/java/io/Externalizable.java
parent4d1da12a32cf622224bb30a3f85131e10c842402 (diff)
downloadgcc-93b3986a7fd5c8e4de2e4c0479e9c4e3866104b0.tar.gz
BufferedOutputStream.java: Reformated.
2003-03-23 Michael Koch <konqueror@gmx.de> * java/io/BufferedOutputStream.java: Reformated. * java/io/BufferedReader.java: Reformated. * java/io/ByteArrayOutputStream.java (size): Fixed @see tag. * java/io/CharArrayWriter.java (size): Fixed @see tag. * java/io/DataInput.java: Reformated. * java/io/DataOutput.java: Reformated. * java/io/DataOutputStream.java: Merged copyright years with classpath. * java/io/Externalizable.java: Reformated. * java/io/FileFilter.java: Reformated. * java/io/FileInputStream.java: Merged copyright years with classpath. * java/io/FileOutputStream.java: Merged copyright years with classpath. * java/io/FilePermission.java (FilePermission): Replaced @XXX with FIXME:. * java/io/FileWriter.java: Reformated. * java/io/FilenameFilter.java: Reformated. * java/io/FilterInputStream.java: Reformated. * java/io/FilterOutputStream.java: Reformated. * java/io/FilterReader.java: Reformated. * java/io/FilterWriter.java: Reformated. * java/io/LineNumberInputStream.java (LineNumberInputStream): Replaced @code with HTML tags to make javadoc happy. (getLineNumber): Fixed @return tag. * java/io/ObjectInput.java: Reformated. * java/io/ObjectOutput.java: Reformated. * java/io/ObjectStreamClass.java: Reformated. * java/io/PrintStream.java: Merged copyright years with classpath. * java/io/PushbackReader.java (PushbackReader): Replaced @code with @param. * java/io/SerializablePermission.java: Reformated. * java/io/StreamTokenizer.java (resetSyntax): Fixed @see tag. From-SVN: r64748
Diffstat (limited to 'libjava/java/io/Externalizable.java')
-rw-r--r--libjava/java/io/Externalizable.java116
1 files changed, 57 insertions, 59 deletions
diff --git a/libjava/java/io/Externalizable.java b/libjava/java/io/Externalizable.java
index f6406b0335a..d0d0d4c392e 100644
--- a/libjava/java/io/Externalizable.java
+++ b/libjava/java/io/Externalizable.java
@@ -39,74 +39,72 @@ exception statement from your version. */
package java.io;
/**
- * This interface provides a way that classes can completely control how
- * the data of their object instances are written and read to and from
- * streams. It has two methods which are used to write the data to a stream
- * and to read the data from a stream. The read method must read the data
- * in exactly the way it was written by the write method.
- * <p>
- * Note that classes which implement this interface must take into account
- * that all superclass data must also be written to the stream as well.
- * The class implementing this interface must figure out how to make that
- * happen.
- * <p>
- * This interface can be used to provide object persistence. When an
- * object is to be stored externally, the <code>writeExternal</code> method is
- * called to save state. When the object is restored, an instance is
- * created using the default no-argument constructor and the
- * <code>readExternal</code> method is used to restore the state.
- *
- * @author Aaron M. Renn (arenn@urbanophile.com)
- */
+ * This interface provides a way that classes can completely control how
+ * the data of their object instances are written and read to and from
+ * streams. It has two methods which are used to write the data to a stream
+ * and to read the data from a stream. The read method must read the data
+ * in exactly the way it was written by the write method.
+ * <p>
+ * Note that classes which implement this interface must take into account
+ * that all superclass data must also be written to the stream as well.
+ * The class implementing this interface must figure out how to make that
+ * happen.
+ * <p>
+ * This interface can be used to provide object persistence. When an
+ * object is to be stored externally, the <code>writeExternal</code> method is
+ * called to save state. When the object is restored, an instance is
+ * created using the default no-argument constructor and the
+ * <code>readExternal</code> method is used to restore the state.
+ *
+ * @author Aaron M. Renn (arenn@urbanophile.com)
+ */
public interface Externalizable extends Serializable
{
static final long serialVersionUID = -282491828744381764L;
/**
- * This method restores an object's state by reading in the instance data
- * for the object from the passed in stream. Note that this stream is not
- * a subclass of <code>InputStream</code>, but rather is a class that
- * implements
- * the <code>ObjectInput</code> interface. That interface provides a
- * mechanism for
- * reading in Java data types from a stream.
- * <p>
- * Note that this method must be compatible with <code>writeExternal</code>.
- * It must read back the exact same types that were written by that
- * method in the exact order they were written.
- * <p>
- * If this method needs to read back an object instance, then the class
- * for that object must be found and loaded. If that operation fails,
- * then this method throws a <code>ClassNotFoundException</code>
- *
- * @param in An <code>ObjectInput</code> instance for reading in the object
- * state
- *
- * @exception ClassNotFoundException If the class of an object being
- * restored cannot be found
- * @exception IOException If any other error occurs
- */
+ * This method restores an object's state by reading in the instance data
+ * for the object from the passed in stream. Note that this stream is not
+ * a subclass of <code>InputStream</code>, but rather is a class that
+ * implements
+ * the <code>ObjectInput</code> interface. That interface provides a
+ * mechanism for
+ * reading in Java data types from a stream.
+ * <p>
+ * Note that this method must be compatible with <code>writeExternal</code>.
+ * It must read back the exact same types that were written by that
+ * method in the exact order they were written.
+ * <p>
+ * If this method needs to read back an object instance, then the class
+ * for that object must be found and loaded. If that operation fails,
+ * then this method throws a <code>ClassNotFoundException</code>
+ *
+ * @param in An <code>ObjectInput</code> instance for reading in the object
+ * state
+ *
+ * @exception ClassNotFoundException If the class of an object being
+ * restored cannot be found
+ * @exception IOException If any other error occurs
+ */
public abstract void readExternal(ObjectInput in)
throws ClassNotFoundException, IOException;
- /*************************************************************************/
-
/**
- * This method is responsible for writing the instance data of an object
- * to the passed in stream. Note that this stream is not a subclass of
- * <code>OutputStream</code>, but rather is a class that implements the
- * <code>ObjectOutput</code> interface. That interface provides a
- * number of methods
- * for writing Java data values to a stream.
- * <p>
- * Not that the implementation of this method must be coordinated with
- * the implementation of <code>readExternal</code>.
- *
- * @param out An <code>ObjectOutput</code> instance for writing the
- * object state
- *
- * @exception IOException If an error occurs
- */
+ * This method is responsible for writing the instance data of an object
+ * to the passed in stream. Note that this stream is not a subclass of
+ * <code>OutputStream</code>, but rather is a class that implements the
+ * <code>ObjectOutput</code> interface. That interface provides a
+ * number of methods
+ * for writing Java data values to a stream.
+ * <p>
+ * Not that the implementation of this method must be coordinated with
+ * the implementation of <code>readExternal</code>.
+ *
+ * @param out An <code>ObjectOutput</code> instance for writing the
+ * object state
+ *
+ * @exception IOException If an error occurs
+ */
public abstract void writeExternal(ObjectOutput out) throws IOException;
} // interface Externalizable