org.scijava.event

Class DefaultEventBus

java.lang.Object

org.scijava.event.bushe.ThreadSafeEventService

org.scijava.event.DefaultEventBus

public class DefaultEventBus
extends ThreadSafeEventService

An org.scijava.event.bushe.EventService implementation for SciJava.

It is called "DefaultEventBus" rather than "DefaultEventService" to avoid a name clash with DefaultEventService, which is not an org.scijava.event.bushe.EventService but rather a SciJava Service implementation.

Author:

Curtis Rueden

Field Summary

Fields inherited from class org.scijava.event.bushe.ThreadSafeEventService

CLEANUP_PERIOD_MS_DEFAULT, CLEANUP_START_THRESHOLD_DEFAULT, CLEANUP_STOP_THRESHOLD_DEFAULT, LOG

Constructor Summary

Constructors

Constructor and Description
DefaultEventBus(ThreadService threadService, LogService log)

Method Summary

Modifier and Type	Method and Description
void	publish(Object event) Publishes an object so that subscribers will be notified if they subscribed to the object's class, one of its subclasses, or to one of the interfaces it implements.
protected void	publish(Object event, String topic, Object eventObj, List subscribers, List vetoSubscribers, StackTraceElement[] callingStack) All publish methods call this method.
void	publish(String topicName, Object eventObj) Publishes an object on a topic name so that all subscribers to that name or a Regular Expression that matches the topic name will be notified.
void	publish(Type genericType, Object event) Use this method to publish generified objects to subscribers of Types, i.e. subscribers that use subscribe(Type, EventSubscriber), and to publish to subscribers of the non-generic type.
void	publishLater(Object event)
void	publishLater(String topicName, Object eventObj)
void	publishLater(Type genericType, Object event)
void	publishNow(Object event)
void	publishNow(String topicName, Object eventObj)
void	publishNow(Type genericType, Object event)

Methods inherited from class org.scijava.event.bushe.ThreadSafeEventService

addEventToCache, clearAllSubscribers, clearCache, clearCache, clearCache, clearCache, decWeakRefPlusProxySubscriberCount, getCachedEvents, getCachedTopicData, getCacheSizeForEventClass, getCacheSizeForTopic, getCleanupPeriodMS, getCleanupStartThreshhold, getCleanupStopThreshold, getDefaultCacheSizePerClassOrTopic, getLastEvent, getLastTopicData, getRealSubscriberAndCleanStaleSubscriberIfNecessary, getSubscribers, getSubscribers, getSubscribers, getSubscribers, getSubscribersByPattern, getSubscribersToClass, getSubscribersToExactClass, getSubscribersToPattern, getSubscribersToTopic, getVetoEventListeners, getVetoSubscribers, getVetoSubscribers, getVetoSubscribers, getVetoSubscribersByPattern, getVetoSubscribersToClass, getVetoSubscribersToExactClass, getVetoSubscribersToTopic, handleException, handleException, handleVeto, incWeakRefPlusProxySubscriberCount, onEventException, removeProxySubscriber, setCacheSizeForEventClass, setCacheSizeForTopic, setCacheSizeForTopic, setCleanupPeriodMS, setCleanupStartThreshhold, setCleanupStopThreshold, setDefaultCacheSizePerClassOrTopic, setStatus, subscribe, subscribe, subscribe, subscribe, subscribe, subscribeExactly, subscribeExactlyStrongly, subscribeStrongly, subscribeStrongly, subscribeStrongly, subscribeVetoException, subscribeVetoListener, subscribeVetoListener, subscribeVetoListener, subscribeVetoListener, subscribeVetoListenerExactly, subscribeVetoListenerExactlyStrongly, subscribeVetoListenerStrongly, subscribeVetoListenerStrongly, subscribeVetoListenerStrongly, unsubscribe, unsubscribe, unsubscribe, unsubscribe, unsubscribe, unsubscribe, unsubscribe, unsubscribeExactly, unsubscribeExactly, unsubscribeVeto, unsubscribeVeto, unsubscribeVeto, unsubscribeVetoExactly, unsubscribeVetoListener, unsubscribeVetoListener, unsubscribeVetoListener, unsubscribeVetoListener, unsubscribeVetoListenerExactly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultEventBus

public DefaultEventBus(ThreadService threadService,
                       LogService log)

Method Detail

publishNow

public void publishNow(Object event)

publishNow

public void publishNow(Type genericType,
                       Object event)

publishNow

public void publishNow(String topicName,
                       Object eventObj)

publishLater

public void publishLater(Object event)

publishLater

public void publishLater(Type genericType,
                         Object event)

publishLater

public void publishLater(String topicName,
                         Object eventObj)

publish

public void publish(Object event)

Publishes an object so that subscribers will be notified if they subscribed to the object's class, one of its subclasses, or to one of the interfaces it implements.

Overrides:

publish in class ThreadSafeEventService

Parameters:

event - the object to publish

See Also:

EventService.publish(Object)

publish

public void publish(Type genericType,
                    Object event)

Use this method to publish generified objects to subscribers of Types, i.e. subscribers that use subscribe(Type, EventSubscriber), and to publish to subscribers of the non-generic type.

Due to generic type erasure, the type must be supplied by the caller. You can get a declared object's type by using the TypeReference class. For Example:

 TypeReference<List<Trade>> subscribingTypeReference = new TypeReference<List<Trade>>(){};
 EventBus.subscribe(subscribingTypeReference.getType(), mySubscriber);
 EventBus.subscribe(List.class, thisSubscriberWillGetCalledToo);
 ...
 //Likely in some other class
 TypeReference<List<Trade>> publishingTypeReference = new TypeReference<List<Trade>>(){};
 List<Trade> trades = new ArrayList<Trade>();
 EventBus.publish(publishingTypeReference.getType(), trades);
 trades.add(trade);
 EventBus.publish(publishingTypeReference.getType(), trades);
 

Overrides:

publish in class ThreadSafeEventService

Parameters:

genericType - the generified type of the published object.

event - The event that occurred

See Also:

EventService.publish(java.lang.reflect.Type, Object)

publish

public void publish(String topicName,
                    Object eventObj)

Publishes an object on a topic name so that all subscribers to that name or a Regular Expression that matches the topic name will be notified.

Overrides:

publish in class ThreadSafeEventService

Parameters:

topicName - The name of the topic subscribed to

eventObj - the object to publish

See Also:

EventService.publish(String,Object)

publish

protected void publish(Object event,
                       String topic,
                       Object eventObj,
                       List subscribers,
                       List vetoSubscribers,
                       StackTraceElement[] callingStack)

Description copied from class: ThreadSafeEventService

All publish methods call this method. Extending classes only have to override this method to handle all publishing cases.

Overrides:

publish in class ThreadSafeEventService

Parameters:

event - the event to publish, null if publishing on a topic

topic - if publishing on a topic, the topic to publish on, else null

eventObj - if publishing on a topic, the eventObj to publish, else null

subscribers - the subscribers to publish to - must be a snapshot copy

vetoSubscribers - the veto subscribers to publish to - must be a snapshot copy.

callingStack - the stack that called this publication, helpful for reporting errors on other threads