com.threerings.presents.dobj

Class ObjectAddedEvent

java.lang.Object

com.threerings.presents.dobj.DEvent

com.threerings.presents.dobj.NamedEvent

com.threerings.presents.dobj.ObjectAddedEvent

All Implemented Interfaces:

Streamable

public class ObjectAddedEvent
extends NamedEvent

An object added event is dispatched when an object is added to an OidList attribute of a distributed object. It can also be constructed to request the addition of an oid to an OidList attribute of an object and posted to the dobjmgr.

See Also:

DObjectManager.postEvent(com.threerings.presents.dobj.DEvent)

Nested Class Summary

Nested classes/interfaces inherited from interface com.threerings.io.Streamable

Streamable.Closure

Field Summary

Fields inherited from class com.threerings.presents.dobj.DEvent

eventId

Constructor Summary

Constructors

Constructor and Description
ObjectAddedEvent(int targetOid, String name, int oid) Constructs a new object added event on the specified target object with the supplied oid list attribute name and object id to add.

Method Summary

Modifier and Type	Method and Description
boolean	alreadyApplied() If this event applies itself immediately to the distributed object on the server and then NOOPs later when DEvent.applyToObject(com.threerings.presents.dobj.DObject) is called, it should return true from this method.
boolean	applyToObject(DObject target) Applies the attribute modifications represented by this event to the specified target object.
int	getOid() Returns the oid that has been added.

Methods inherited from class com.threerings.presents.dobj.NamedEvent

getName

Methods inherited from class com.threerings.presents.dobj.DEvent

getActualTransport, getSourceOid, getTargetOid, getTransport, isPrivate, noteActualTransport, setSourceOid, setTargetOid, setTransport, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectAddedEvent

public ObjectAddedEvent(int targetOid,
                        String name,
                        int oid)

Constructs a new object added event on the specified target object with the supplied oid list attribute name and object id to add.

Parameters:

targetOid - the object id of the object to whose oid list we will add an oid.

name - the name of the attribute (data member) to which to add the specified oid.

oid - the oid to add to the oid list attribute.

Method Detail

getOid

public int getOid()

Returns the oid that has been added.

alreadyApplied

public boolean alreadyApplied()

Description copied from class: DEvent

If this event applies itself immediately to the distributed object on the server and then NOOPs later when DEvent.applyToObject(com.threerings.presents.dobj.DObject) is called, it should return true from this method. If it will modify the object during its DEvent.applyToObject(com.threerings.presents.dobj.DObject) call, it should return false.

Overrides:

alreadyApplied in class DEvent

applyToObject

public boolean applyToObject(DObject target)
                      throws ObjectAccessException

Description copied from class: DEvent

Applies the attribute modifications represented by this event to the specified target object. This is called by the distributed object manager in the course of dispatching events and should not be called directly.

Specified by:

applyToObject in class DEvent

Returns:

true if the object manager should go on to notify the object's listeners of this event, false if the event should be treated silently and the listeners should not be notified.

Throws:

ObjectAccessException - thrown if there is any problem applying the event to the object (invalid attribute, etc.).