Clearspace API (2.5.18) Core Javadocs

com.jivesoftware.community.event
Class AnnouncementEventDispatcher

java.lang.Object
  extended by com.jivesoftware.community.event.AnnouncementEventDispatcher

public class AnnouncementEventDispatcher
extends Object

Dispatcher for AnnouncementEvents. Register AnnouncementListeners at runtime using the addListener(AnnouncementListener) method, or add a child Jive Property to the key "eventListeners.AnnouncementListener" to register a listener that will persist across restarts.

For example, to register the com.acme.CustomAnnouncementListener class as a persistent listener the following code could be used: // add persistent key to have the listener loaded and registered automatically at startup JiveGlobals.setJiveProperty("eventListeners.AnnouncementListener.customAnnouncementListener", "com.acme.CustomAnnouncementListener.class"); // now add it for this runtime instance AnnouncementEventDispatcher.addListener(new com.acme.CustomerAnnouncementListener());


Method Summary
 void addListener(AnnouncementListener listener)
           
static void destroy()
          Destroy dispatcher.
 void dispatchEvent(AnnouncementEvent event)
           
static AnnouncementEventDispatcher getInstance()
           
 void removeListener(AnnouncementListener listener)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getInstance

public static AnnouncementEventDispatcher getInstance()

addListener

public void addListener(AnnouncementListener listener)

removeListener

public void removeListener(AnnouncementListener listener)

destroy

public static void destroy()
Destroy dispatcher. Intended to be used primarily during testing.


dispatchEvent

public void dispatchEvent(AnnouncementEvent event)

Clearspace Project Page

Copyright © 1999-2007 Jive Software.