org.jvoicexml.event

Class EventBus

java.lang.Object

org.jvoicexml.event.EventBus

public final class EventBus
extends java.lang.Object

An event bus to transport events between interpreter and implementation platform. Events are published via a simple publish-subscribe mechanism. EventSubscribers can indicate their interest in a certain event type by registering via subscribe(String, EventSubscriber). Events can be published to all EventSubscribers via publish(JVoiceXMLEvent).

Since:

0.7.7

Constructor Summary

Constructors

Constructor and Description
EventBus() Constructs a new object.

Method Summary

Modifier and Type	Method and Description
void	publish(JVoiceXMLEvent event) Publishes the given event to all registered subscribers.
void	subscribe(java.lang.String type, EventSubscriber subscriber) Subscribes the given subscriber for the given event type or subtypes.
boolean	unsubscribe(java.lang.String type, EventSubscriber subscriber) Unsubscribes the given subscriber from the given event type.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventBus

public EventBus()

Constructs a new object.

Method Detail

subscribe

public void subscribe(java.lang.String type,
                      EventSubscriber subscriber)

Subscribes the given subscriber for the given event type or subtypes. The latter are separated by a '.'. For instance, a subscription to events of the type BadFetchError would include a subscription to events of the type BadFetchHttpResponsecodeError.

Parameters:

type - the event type

subscriber - the subscriber

unsubscribe

public boolean unsubscribe(java.lang.String type,
                           EventSubscriber subscriber)

Unsubscribes the given subscriber from the given event type.

Parameters:

type - the event type

subscriber - the subscriber

Returns:

true if the subscription was removed

publish

public void publish(JVoiceXMLEvent event)

Publishes the given event to all registered subscribers.

Parameters:

event - the event to publish