Wildfire 3.2.4 Javadoc

org.jivesoftware.util
Class PropertyEventDispatcher

java.lang.Object
  extended by org.jivesoftware.util.PropertyEventDispatcher

public class PropertyEventDispatcher
extends Object

Dispatches property events. Each event has a type and optional parameters, as follows:

Event TypeExtra Params
property_setA param named value that has the value of the property set.
property_deletedNone
xml_property_setA param named value that has the value of the property set.
xml_property_deletedNone

Author:
Matt Tucker

Nested Class Summary
static class PropertyEventDispatcher.EventType
          Represents valid event types.
 
Method Summary
static void addListener(PropertyEventListener listener)
          Registers a listener to receive events.
static void dispatchEvent(String property, PropertyEventDispatcher.EventType eventType, Map<String,Object> params)
          Dispatches an event to all listeners.
static void removeListener(PropertyEventListener listener)
          Unregisters a listener to receive events.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

addListener

public static void addListener(PropertyEventListener listener)
Registers a listener to receive events.

Parameters:
listener - the listener.

removeListener

public static void removeListener(PropertyEventListener listener)
Unregisters a listener to receive events.

Parameters:
listener - the listener.

dispatchEvent

public static void dispatchEvent(String property,
                                 PropertyEventDispatcher.EventType eventType,
                                 Map<String,Object> params)
Dispatches an event to all listeners.

Parameters:
property - the property.
eventType - the event type.
params - event parameters.

Wildfire 3.2.4 Javadoc

Copyright © 2003-2007 Jive Software.