Clarify that SetListeners get all Entry events, not just the ones for a particular set

git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@4939 542714f4-19e9-0310-aa3c-eee0fc999fb1
This commit is contained in:
Charlie Groves
2008-02-19 23:05:30 +00:00
parent 7564f88796
commit 8a7f4c4121
2 changed files with 13 additions and 5 deletions
@@ -22,8 +22,12 @@
package com.threerings.presents.dobj; package com.threerings.presents.dobj;
/** /**
* Implements the methods in SetListener so that you don't have to * Implements the methods in SetListener so that you don't have to implement the ones you don't
* implement the ones you don't want to. * want to.
*
* <p> <b>NOTE:</b> This adapter will receive <em>all</em> Entry events from a DObject it's
* listening to, so it should check that the event's name matches the field it's interested in
* before acting on the event.
*/ */
public class SetAdapter<T extends DSet.Entry> implements SetListener<T> public class SetAdapter<T extends DSet.Entry> implements SetListener<T>
{ {
@@ -22,8 +22,12 @@
package com.threerings.presents.dobj; package com.threerings.presents.dobj;
/** /**
* Implemented by entities which wish to hear about changes that occur to * Implemented by entities which wish to hear about changes that occur to set attributes of a
* set attributes of a particular distributed object. * particular distributed object.
*
* <p> <b>NOTE:</b> This listener will receive <em>all</em> Entry events from a DObject it's
* listening to, so it should check that the event's name matches the field it's interested in
* before acting on the event.
* *
* @see DObject#addListener * @see DObject#addListener
*/ */