AfflictionNetworks/narya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Widened, removed misleading comment. It's all non-transient fields, not all

Browse Source 
non-transient public fields.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4600 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Michael Bayne
2007-02-23 19:59:18 +00:00
parent 3c4f1728d5
commit d3064398e9
1 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/java/com/threerings/io/Streamable.java
+9 -12
View File
@@ -22,25 +22,22 @@
package com.threerings.io; package com.threerings.io;
/** /**
* Marks an object as streamable, meaning that it can be written to {@link * Marks an object as streamable, meaning that it can be written to {@link ObjectOutputStream}
* ObjectOutputStream} instances and read from {@link ObjectInputStream} * instances and read from {@link ObjectInputStream} instances.
* instances.
* *
* <p> All non-<code>transient</code> public fields will be automatically * <p> All non-<code>transient</code> fields will be automatically written and restored for a
* written and restored for a {@link Streamable} instance. Classes that * {@link Streamable} instance. Classes that wish to stream non-public fields or customize the
* wish to stream non-public fields or customize the streaming process * streaming process should implement methods with the following signatures:
* should implement methods with the following signatures:
* *
* <p><code> * <p><code>
* public void writeObject ({@link ObjectOutputStream} out); * public void writeObject ({@link ObjectOutputStream} out);
* public void readObject ({@link ObjectInputStream} in); * public void readObject ({@link ObjectInputStream} in);
* </code> * </code>
* *
* <p> They can then handle the entirety of the streaming process, or call * <p> They can then handle the entirety of the streaming process, or call {@link
* {@link ObjectOutputStream#defaultWriteObject} and {@link * ObjectOutputStream#defaultWriteObject} and {@link ObjectInputStream#defaultReadObject} from
* ObjectInputStream#defaultReadObject} from within their * within their <code>writeObject</code> and <code>readObject</code> methods to perform the
* <code>writeObject</code> and <code>readObject</code> methods to perform * standard streaming in addition to their customized behavior.
* the standard streaming in addition to their customized behavior.
*/ */
public interface Streamable public interface Streamable
{ {