Added a bit of documentation about what makes OidLists special;

I myself couldn't even remember and had to trace through code.


git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@5179 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Ray Greenwell
2008-06-11 22:50:27 +00:00
parent 6abd794182
commit e9ab6f4635
@@ -28,6 +28,12 @@ import com.threerings.io.Streamable;
* allow duplicate ids. This class is not synchronized, with the
* expectation that all modifications of instances will take place on the
* dobjmgr thread.
*
* <ul>
* <li> Do not use an OidList to store a set of ints. OidList has special meaning inside
* of the dobj system, namely:
* <li> When an object is destroyed, its oid is automagically removed from any OidLists.
* </ul>
*/
public class OidList implements Streamable
{