com.threerings.presents.dobj

Class EntryRemovedEvent<T extends DSet.Entry>

java.lang.Object

com.threerings.presents.dobj.DEvent

com.threerings.presents.dobj.NamedEvent

com.threerings.presents.dobj.EntryEvent<T>

com.threerings.presents.dobj.EntryRemovedEvent<T>

Type Parameters:

T - the type of entry being handled by this event. This must match the type on the set that generated this event.

All Implemented Interfaces:

Streamable

public class EntryRemovedEvent<T extends DSet.Entry>
extends EntryEvent<T>

An entry removed event is dispatched when an entry is removed from a DSet attribute of a distributed object. It can also be constructed to request the removal of an entry from a set 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
EntryRemovedEvent(int targetOid, String name, Comparable<?> key) Constructs a new entry removed event on the specified target object with the supplied set attribute name and entry key to remove.

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.
T	getEntry() Return the new or updated entry, or null if the entry was removed.
Comparable<?>	getKey() Return the key that identifies the entry related to this event.
T	getOldEntry() Return the old entry, or null if the entry is newly 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

EntryRemovedEvent

public EntryRemovedEvent(int targetOid,
                         String name,
                         Comparable<?> key)

Constructs a new entry removed event on the specified target object with the supplied set attribute name and entry key to remove.

Parameters:

targetOid - the object id of the object from whose set we will remove an entry.

name - the name of the attribute from which to remove the specified entry.

key - the entry key that identifies the entry to remove.

Method Detail

getKey

public Comparable<?> getKey()

Description copied from class: EntryEvent

Return the key that identifies the entry related to this event. Never returns null.

Specified by:

getKey in class EntryEvent<T extends DSet.Entry>

getEntry

public T getEntry()

Return the new or updated entry, or null if the entry was removed. This implementation always returns null.

Specified by:

getEntry in class EntryEvent<T extends DSet.Entry>

getOldEntry

public T getOldEntry()

Return the old entry, or null if the entry is newly added. This implementation never returns null.

Specified by:

getOldEntry in class EntryEvent<T extends DSet.Entry>

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