com.threerings.presents.dobj
Class ObjectRemovedEvent

java.lang.Object
  com.threerings.presents.dobj.DEvent
      com.threerings.presents.dobj.NamedEvent
          com.threerings.presents.dobj.ObjectRemovedEvent

All Implemented Interfaces:

Streamable

public class ObjectRemovedEvent
extends NamedEvent

An object removed event is dispatched when an object is removed from an OidList attribute of a distributed object. It can also be constructed to request the removal of an oid from 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

protected boolean	_alreadyApplied
protected int	_oid

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

_name

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

_actualTransport, _soid, _toid, _transport, eventId, UNSET_OLD_ENTRY, UNSET_OLD_VALUE

Constructor Summary

ObjectRemovedEvent(int targetOid, String name, int oid)
Constructs a new object removed event on the specified target object with the supplied oid list attribute name and object id to remove.

Method Summary

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 removed.
protected void	notifyListener(Object listener) Events with associated listener interfaces should implement this function and notify the supplied listener if it implements their event listening interface.
protected ObjectRemovedEvent	setAlreadyApplied(boolean alreadyApplied) Used by DObject to note if this event has already been applied locally.
protected void	toString(StringBuilder buf) This should be overridden by derived classes (which should be sure to call super.toString()) to append the derived class specific event information to the string buffer.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_oid

protected int _oid

_alreadyApplied

protected transient boolean _alreadyApplied

Constructor Detail

ObjectRemovedEvent

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

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

Parameters:

targetOid - the object id of the object from whose oid list we will remove an oid.

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

oid - the oid to remove from the oid list attribute.

Method Detail

getOid

public int getOid()

Returns the oid that has been removed.

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.).

notifyListener

protected void notifyListener(Object listener)

Description copied from class: DEvent

Events with associated listener interfaces should implement this function and notify the supplied listener if it implements their event listening interface. For example, the AttributeChangedEvent will notify listeners that implement AttributeChangeListener.

Overrides:

notifyListener in class DEvent

toString

protected void toString(StringBuilder buf)

Description copied from class: DEvent

This should be overridden by derived classes (which should be sure to call super.toString()) to append the derived class specific event information to the string buffer.

Overrides:

toString in class NamedEvent

setAlreadyApplied

protected ObjectRemovedEvent setAlreadyApplied(boolean alreadyApplied)

Used by DObject to note if this event has already been applied locally.