From d3064398e9306e34c77c9f1d170f9d201133e8c1 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Fri, 23 Feb 2007 19:59:18 +0000 Subject: [PATCH] Widened, removed misleading comment. It's all non-transient fields, not all non-transient public fields. git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4600 542714f4-19e9-0310-aa3c-eee0fc999fb1 --- src/java/com/threerings/io/Streamable.java | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/src/java/com/threerings/io/Streamable.java b/src/java/com/threerings/io/Streamable.java index 111513bac..cb58b4bf7 100644 --- a/src/java/com/threerings/io/Streamable.java +++ b/src/java/com/threerings/io/Streamable.java @@ -22,25 +22,22 @@ package com.threerings.io; /** - * Marks an object as streamable, meaning that it can be written to {@link - * ObjectOutputStream} instances and read from {@link ObjectInputStream} - * instances. + * Marks an object as streamable, meaning that it can be written to {@link ObjectOutputStream} + * instances and read from {@link ObjectInputStream} instances. * - *

All non-transient public fields will be automatically - * written and restored for a {@link Streamable} instance. Classes that - * wish to stream non-public fields or customize the streaming process - * should implement methods with the following signatures: + *

All non-transient fields will be automatically written and restored for a + * {@link Streamable} instance. Classes that wish to stream non-public fields or customize the + * streaming process should implement methods with the following signatures: * *

* public void writeObject ({@link ObjectOutputStream} out); * public void readObject ({@link ObjectInputStream} in); * * - *

They can then handle the entirety of the streaming process, or call - * {@link ObjectOutputStream#defaultWriteObject} and {@link - * ObjectInputStream#defaultReadObject} from within their - * writeObject and readObject methods to perform - * the standard streaming in addition to their customized behavior. + *

They can then handle the entirety of the streaming process, or call {@link + * ObjectOutputStream#defaultWriteObject} and {@link ObjectInputStream#defaultReadObject} from + * within their writeObject and readObject methods to perform the + * standard streaming in addition to their customized behavior. */ public interface Streamable {