001 package users.events;
002
003 /**
004 * An abstract adapter class for receiving capability data events. The methods in this
005 * class are empty. This class exists as convenience for creating listener objects.
006 *
007 * <p>Extend this class to create a CapabilityDataEvent listener and override the methods
008 * for the events of interest. (If you implement the CapabilityDataListener interface, you
009 * have to define all of the methods in it. This abstract class defines empty method bodies for
010 * them all, so you can concentrate on defining methods only for events you care about.)</p>
011 *
012 * <p>Create a listener object using the extended class and then register it with a
013 * user using the user's {@link users.User#addCapabilityDataListener} method. When a capability
014 * is added or replaced, the relevant method in the listener object is invoked, and the
015 * {@link CapabilityDataEvent} is passed to it.</p>
016 *
017 * @see CapabilityDataEvent
018 * @see CapabilityDataListener
019 * @see users.User
020 * @see users.Capability
021 *
022 * @author Steffen Zschaler
023 * @version 2.0 06/05/1999
024 * @since v2.0
025 */
026 public abstract class CapabilityDataAdapter implements CapabilityDataListener {
027
028 /**
029 * Called whenever capabilities where added to the source. The new capabilities
030 * will be contained in the event object.
031 *
032 * @param e the event object describing the event.
033 *
034 * @override Sometimes
035 */
036 public void capabilitiesAdded(CapabilityDataEvent e) {};
037
038 /**
039 * Called whenever capabilities where replaced in the source. The new capabilities
040 * will be contained in the event object.
041 *
042 * @param e the event object describing the event.
043 *
044 * @override Sometimes
045 */
046 public void capabilitiesReplaced(CapabilityDataEvent e) {};
047 }