diff --git a/src/java/com/threerings/io/ObjectInputStream.java b/src/java/com/threerings/io/ObjectInputStream.java index e41639203..833bc408c 100644 --- a/src/java/com/threerings/io/ObjectInputStream.java +++ b/src/java/com/threerings/io/ObjectInputStream.java @@ -34,17 +34,15 @@ import com.samskivert.util.StringUtil; import static com.threerings.NaryaLog.log; /** - * Used to read {@link Streamable} objects from an {@link InputStream}. - * Other common object types are supported as well (@see {@link - * ObjectOutputStream}). + * Used to read {@link Streamable} objects from an {@link InputStream}. Other common object types + * are supported as well (@see {@link ObjectOutputStream}). * * @see Streamable */ public class ObjectInputStream extends DataInputStream { /** - * Constructs an object input stream which will read its data from the - * supplied source stream. + * Constructs an object input stream which will read its data from the supplied source stream. */ public ObjectInputStream (InputStream source) { @@ -52,8 +50,7 @@ public class ObjectInputStream extends DataInputStream } /** - * Customizes the class loader used to instnatiate objects read from - * the input stream. + * Customizes the class loader used to instnatiate objects read from the input stream. */ public void setClassLoader (ClassLoader loader) { @@ -61,9 +58,9 @@ public class ObjectInputStream extends DataInputStream } /** - * Configures this object input stream with a mapping from an old - * class name to a new one. Serialized instances of the old class name - * will use the new class name when unserializing. + * Configures this object input stream with a mapping from an old class name to a new + * one. Serialized instances of the old class name will use the new class name when + * unserializing. */ public void addTranslation (String oldname, String newname) { @@ -74,8 +71,8 @@ public class ObjectInputStream extends DataInputStream } /** - * Reads a {@link Streamable} instance or one of the supported object - * types from the input stream. + * Reads a {@link Streamable} instance or one of the supported object types from the input + * stream. */ public Object readObject () throws IOException, ClassNotFoundException @@ -100,16 +97,16 @@ public class ObjectInputStream extends DataInputStream } return null; - // if the code is negative, that means that we've never - // seen it before and class metadata follows + // if the code is negative, that means that we've never seen it before and class + // metadata follows } else if (code < 0) { // first swap the code into positive-land code *= -1; // read in the class metadata String cname = readUTF(); - // if we have a translation (used to cope when serialized - // classes are renamed) use it + // if we have a translation (used to cope when serialized classes are renamed) use + // it if (_translations != null) { String tname = _translations.get(cname); if (tname != null) { @@ -126,9 +123,8 @@ public class ObjectInputStream extends DataInputStream // sanity check if (streamer == null) { - String errmsg = "Aiya! Unable to create streamer for " + - "newly seen class [code=" + code + - ", class=" + cname + "]"; + String errmsg = "Aiya! Unable to create streamer for newly seen class " + + "[code=" + code + ", class=" + cname + "]"; throw new RuntimeException(errmsg); } @@ -146,8 +142,8 @@ public class ObjectInputStream extends DataInputStream Thread.dumpStack(); log.warning( "ObjectInputStream mappings " + StringUtil.toString(_classmap) + "."); - String errmsg = "Read object code for which we " + - "have no registered class metadata [code=" + code + "]"; + String errmsg = "Read object code for which we have no registered class " + + "metadata [code=" + code + "]"; throw new RuntimeException(errmsg); } } @@ -167,11 +163,11 @@ public class ObjectInputStream extends DataInputStream } /** - * Reads an object from the input stream that was previously written - * with {@link ObjectOutputStream#writeBareObject}. + * Reads an object from the input stream that was previously written with {@link + * ObjectOutputStream#writeBareObject}. * - * @param object the object to be populated from data on the stream. - * It cannot be null. + * @param object the object to be populated from data on the stream. It cannot be + * null. */ public void readBareObject (Object object) throws IOException, ClassNotFoundException @@ -180,18 +176,16 @@ public class ObjectInputStream extends DataInputStream } /** - * Reads an object from the input stream that was previously written - * with {@link ObjectOutputStream#writeBareObject}. + * Reads an object from the input stream that was previously written with {@link + * ObjectOutputStream#writeBareObject}. */ - protected void readBareObject ( - Object object, Streamer streamer, boolean useReader) + protected void readBareObject (Object object, Streamer streamer, boolean useReader) throws IOException, ClassNotFoundException { _current = object; _streamer = streamer; try { _streamer.readObject(object, this, useReader); - } finally { // clear out our current object references _current = null; @@ -200,18 +194,16 @@ public class ObjectInputStream extends DataInputStream } /** - * Reads the fields of the specified {@link Streamable} instance from - * the input stream using the default object streaming mechanisms (a - * call is not made to readObject(), even if such a - * method exists). + * Reads the fields of the specified {@link Streamable} instance from the input stream using + * the default object streaming mechanisms (a call is not made to readObject(), + * even if such a method exists). */ public void defaultReadObject () throws IOException, ClassNotFoundException { // sanity check if (_current == null) { - throw new RuntimeException( - "defaultReadObject() called illegally."); + throw new RuntimeException("defaultReadObject() called illegally."); } // read the instance data @@ -224,12 +216,11 @@ public class ObjectInputStream extends DataInputStream public String toString () { return "[hash=" + hashCode() + ", mappings=" + _classmap.size() + - ", current=" + StringUtil.safeToString(_current) + - ", streamer=" + _streamer + "]"; + ", current=" + StringUtil.safeToString(_current) + ", streamer=" + _streamer + "]"; } - /** Used to map classes to numeric codes and the {@link Streamer} - * instance used to write them. */ + /** Used to map classes to numeric codes and the {@link Streamer} instance used to write + * them. */ protected ArrayList _classmap; /** The object currently being read from the stream. */ @@ -241,8 +232,7 @@ public class ObjectInputStream extends DataInputStream /** The class loader we use to instantiate objects. */ protected ClassLoader _loader = getClass().getClassLoader(); - /** An optional set of class name translations to use when - * unserializing objects. */ + /** An optional set of class name translations to use when unserializing objects. */ protected HashMap _translations; /** Used to activate verbose debug logging. */ diff --git a/src/java/com/threerings/io/ObjectOutputStream.java b/src/java/com/threerings/io/ObjectOutputStream.java index 1dc88cec7..9decbaa4f 100644 --- a/src/java/com/threerings/io/ObjectOutputStream.java +++ b/src/java/com/threerings/io/ObjectOutputStream.java @@ -27,8 +27,8 @@ import java.io.IOException; import java.util.HashMap; /** - * Used to write {@link Streamable} objects to an {@link OutputStream}. - * Other common object types are supported as well: + * Used to write {@link Streamable} objects to an {@link OutputStream}. Other common object types + * are supported as well: * *
  * Boolean
@@ -55,8 +55,7 @@ import java.util.HashMap;
 public class ObjectOutputStream extends DataOutputStream
 {
     /**
-     * Constructs an object output stream which will write its data to the
-     * supplied target stream.
+     * Constructs an object output stream which will write its data to the supplied target stream.
      */
     public ObjectOutputStream (OutputStream target)
     {
@@ -64,8 +63,7 @@ public class ObjectOutputStream extends DataOutputStream
     }
 
     /**
-     * Configures this object output stream with a mapping from a classname
-     * to a streamed name.
+     * Configures this object output stream with a mapping from a classname to a streamed name.
      */
     public void addTranslation (String className, String streamedName)
     {
@@ -76,8 +74,8 @@ public class ObjectOutputStream extends DataOutputStream
     }
 
     /**
-     * Writes a {@link Streamable} instance or one of the support object
-     * types to the output stream.
+     * Writes a {@link Streamable} instance or one of the support object types to the output
+     * stream.
      */
     public void writeObject (Object object)
         throws IOException
@@ -101,21 +99,18 @@ public class ObjectOutputStream extends DataOutputStream
         if (cmap == null) {
             // create a streamer instance and assign a code to this class
             Streamer streamer = Streamer.getStreamer(sclass);
-            // we specifically do not inline the getStreamer() call
-            // into the ClassMapping constructor because we want to be
-            // sure not to call _nextCode++ if getStreamer() throws an
-            // exception
+            // we specifically do not inline the getStreamer() call into the ClassMapping
+            // constructor because we want to be sure not to call _nextCode++ if getStreamer()
+            // throws an exception
             cmap = new ClassMapping(_nextCode++, sclass, streamer);
             _classmap.put(sclass, cmap);
 
             // make sure we didn't blow past our maximum class count
             if (_nextCode <= 0) {
-                throw new RuntimeException("Too many unique classes " +
-                                           "written to ObjectOutputStream");
+                throw new RuntimeException("Too many unique classes written to ObjectOutputStream");
             }
 
-            // writing a negative class code indicates that the class
-            // name will follow
+            // writing a negative class code indicates that the class name will follow
             writeShort(-cmap.code);
             String cname = sclass.getName();
             if (_translations != null) {
@@ -134,34 +129,29 @@ public class ObjectOutputStream extends DataOutputStream
     }
 
     /**
-     * Writes a {@link Streamable} instance or one of the support object
-     * types without associated class metadata to the output
-     * stream. The caller is responsible for knowing the exact class of
-     * the written object, creating an instance of such and calling {@link
+     * Writes a {@link Streamable} instance or one of the support object types without
+     * associated class metadata to the output stream. The caller is responsible for knowing
+     * the exact class of the written object, creating an instance of such and calling {@link
      * ObjectInputStream#readBareObject} to read its data from the stream.
      *
-     * @param object the object to be written. It cannot be
-     * null.
+     * @param object the object to be written. It cannot be null.
      */
     public void writeBareObject (Object object)
         throws IOException
     {
-        writeBareObject(object, Streamer.getStreamer(
-                            Streamer.getStreamerClass(object)), true);
+        writeBareObject(object, Streamer.getStreamer(Streamer.getStreamerClass(object)), true);
     }
 
     /**
      * Write a {@link Streamable} instance without associated class metadata.
      */
-    protected void writeBareObject (
-            Object obj, Streamer streamer, boolean useWriter)
+    protected void writeBareObject (Object obj, Streamer streamer, boolean useWriter)
         throws IOException
     {
         _current = obj;
         _streamer = streamer;
         try {
             _streamer.writeObject(obj, this, useWriter);
-
         } finally {
             _current = null;
             _streamer = null;
@@ -169,29 +159,26 @@ public class ObjectOutputStream extends DataOutputStream
     }
 
     /**
-     * Uses the default streamable mechanism to write the contents of the
-     * object currently being streamed. This can only be called from
-     * within a writeObject implementation in a {@link
-     * Streamable} object.
+     * Uses the default streamable mechanism to write the contents of the object currently being
+     * streamed. This can only be called from within a writeObject implementation in a
+     * {@link Streamable} object.
      */
     public void defaultWriteObject ()
         throws IOException
     {
         // sanity check
         if (_current == null) {
-            throw new RuntimeException(
-                "defaultWriteObject() called illegally.");
+            throw new RuntimeException("defaultWriteObject() called illegally.");
         }
 
-//         log.info("Writing default [cmap=" + _streamer +
-//                  ", current=" + _current + "].");
+//         log.info("Writing default [cmap=" + _streamer + ", current=" + _current + "].");
 
         // write the instance data
         _streamer.writeObject(_current, this, false);
     }
 
-    /** Used to map classes to numeric codes and the {@link Streamer}
-     * instance used to write them. */
+    /** Used to map classes to numeric codes and the {@link Streamer} instance used to write
+     * them. */
     protected HashMap _classmap;
 
     /** A counter used to assign codes to streamed classes. */
@@ -203,7 +190,6 @@ public class ObjectOutputStream extends DataOutputStream
     /** The streamer being used currently. */
     protected Streamer _streamer;
 
-    /** An optional set of class name translations to use when serializing
-     * objects. */
+    /** An optional set of class name translations to use when serializing objects. */
     protected HashMap _translations;
 }