ch.agent.crnickl.impl

Class UpdateEventPublisherImpl

java.lang.Object

ch.agent.crnickl.impl.UpdateEventPublisherImpl

All Implemented Interfaces:

UpdateEventPublisher

public class UpdateEventPublisherImpl
extends Object
implements UpdateEventPublisher

Default implementation of UpdateEventPublisher.

Author:

Jean-Paul Vetterli

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	UpdateEventPublisherImpl.Subscription A Subscription keeps track of the event types an UpdateEventSubscriber is interested in.

Constructor Summary

Constructors

Constructor and Description
UpdateEventPublisherImpl() Construct an UpdateEventPublisher.

Method Summary

Modifier and Type	Method and Description
int	clear() Forget all events collected without notifying subscribers.
void	publish(UpdateEvent event, boolean immediate) Publish an event.
void	release() Release deferred events.
void	subscribe(UpdateEventSubscriber subscriber, DBObjectType type, boolean priority) Add a subscriber to event for a given database object type.
void	unsubscribe(UpdateEventSubscriber subscriber) Remove a subscriber.
void	unsubscribeAll() Remove all subscribers.

Methods inherited from class java.lang.Object

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

Constructor Detail

UpdateEventPublisherImpl

public UpdateEventPublisherImpl()

Construct an UpdateEventPublisher.

Method Detail

subscribe

public void subscribe(UpdateEventSubscriber subscriber,
                      DBObjectType type,
                      boolean priority)

Description copied from interface: UpdateEventPublisher

Add a subscriber to event for a given database object type. Priority subscribers are notified before non-priority subscribers. It is the client's responsibility to decide when a priority subscription is warranted.

Specified by:

subscribe in interface UpdateEventPublisher

Parameters:

subscriber - an update event subscriber

type - the database object type subscribed to

priority - if true, handle as a priority subscription

unsubscribe

public void unsubscribe(UpdateEventSubscriber subscriber)

Description copied from interface: UpdateEventPublisher

Remove a subscriber.

Specified by:

unsubscribe in interface UpdateEventPublisher

Parameters:

subscriber - an update event subscriber

unsubscribeAll

public void unsubscribeAll()

Description copied from interface: UpdateEventPublisher

Remove all subscribers.

Specified by:

unsubscribeAll in interface UpdateEventPublisher

publish

public void publish(UpdateEvent event,
                    boolean immediate)

Description copied from interface: UpdateEventPublisher

Publish an event. Subscribers are either notified immediately or at a later time when the UpdateEventPublisher.release() method is invoked.

Specified by:

publish in interface UpdateEventPublisher

Parameters:

event - an update event

immediate - if true notify subscribers immediately

release

public void release()

Description copied from interface: UpdateEventPublisher

Release deferred events.

Specified by:

release in interface UpdateEventPublisher

clear

public int clear()

Forget all events collected without notifying subscribers.

Returns:

the number of events collected