Files
narya/src/java/com/threerings/presents/dobj/EntryRemovedEvent.java
T
Michael Bayne a9720fd905 LGPLed the library. Hello world.
git-svn-id: svn+ssh://src.earth.threerings.net/narya/trunk@3099 542714f4-19e9-0310-aa3c-eee0fc999fb1
2004-08-27 02:21:06 +00:00

112 lines
3.4 KiB
Java

//
// $Id: EntryRemovedEvent.java,v 1.17 2004/08/27 02:20:20 mdb Exp $
//
// Narya library - tools for developing networked games
// Copyright (C) 2002-2004 Three Rings Design, Inc., All Rights Reserved
// http://www.threerings.net/code/narya/
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
package com.threerings.presents.dobj;
/**
* An entry removed event is dispatched when an entry is removed from a
* {@link 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 DObjectManager#postEvent
*/
public class EntryRemovedEvent extends NamedEvent
{
/**
* Constructs a new entry removed event on the specified target object
* with the supplied set attribute name and entry key to remove.
*
* @param targetOid the object id of the object from whose set we will
* remove an entry.
* @param name the name of the attribute from which to remove the
* specified entry.
* @param key the entry key that identifies the entry to remove.
* @param oldEntry the previous value of the entry.
*/
public EntryRemovedEvent (int targetOid, String name, Comparable key,
DSet.Entry oldEntry)
{
super(targetOid, name);
_key = key;
_oldEntry = oldEntry;
}
/**
* Constructs a blank instance of this event in preparation for
* unserialization from the network.
*/
public EntryRemovedEvent ()
{
}
/**
* Returns the key that identifies the entry that has been removed.
*/
public Comparable getKey ()
{
return (Comparable)_key;
}
/**
* Returns the entry that was in the set prior to being updated.
*/
public DSet.Entry getOldEntry ()
{
return _oldEntry;
}
/**
* Applies this event to the object.
*/
public boolean applyToObject (DObject target)
throws ObjectAccessException
{
if (_oldEntry == UNSET_OLD_ENTRY) {
DSet set = (DSet)target.getAttribute(_name);
// fetch the previous value for interested callers
_oldEntry = set.get(_key);
// remove it from the set
set.removeKey(_key);
}
return true;
}
// documentation inherited
protected void notifyListener (Object listener)
{
if (listener instanceof SetListener) {
((SetListener)listener).entryRemoved(this);
}
}
// documentation inherited
protected void toString (StringBuffer buf)
{
buf.append("ELREM:");
super.toString(buf);
buf.append(", key=").append(_key);
}
protected Comparable _key;
protected transient DSet.Entry _oldEntry = UNSET_OLD_ENTRY;
}