de.saxsys.mvvmfx.utils.notifications

Interface NotificationCenter

All Known Implementing Classes:

DefaultNotificationCenter

public interface NotificationCenter

Central component to provide a notification mechanism. You can add observers by using keys to get notifications for it. If you want you can pass an Object[] with a notification.

There is a util NotificationTestHelper that's purpose is to simplify testing of notifications in Unit-Tests.

Author:

sialcasa

Method Summary

Modifier and Type	Method and Description
void	publish(Object channel, String messageName, Object[] payload) Publishes a notification on a specific channel.
void	publish(String messageName, Object... payload) Post a notification to all NotificationObserver which are registered with the given String.
void	subscribe(Object channel, String messageName, NotificationObserver observer) Subscribe to a notification with a given NotificationObserver on a specific channel.
void	subscribe(String messageName, NotificationObserver observer) Add an observer to the NotificationCenter which gets notifications for the given String.
void	unsubscribe(NotificationObserver observer) Remove all registrations of an NotificationObserver.
void	unsubscribe(Object channel, NotificationObserver observer) Removes a NotificationObserver for all messageName.
void	unsubscribe(Object channel, String messageName, NotificationObserver observer) Removes a NotificationObserver for a given messageName.
void	unsubscribe(String messageName, NotificationObserver observer) Removes an observer from the NotificationCenter.

Method Detail

subscribe

void subscribe(String messageName,
               NotificationObserver observer)

Add an observer to the NotificationCenter which gets notifications for the given String. Please note: It is possible (but yet untypical) to add the same observer for the same message multiple times. In this case the observer will be invoked multiple times too. As this behaviour is unusual, the default notification center will log a warning message when the same observer is added multiple times for the same message.

Parameters:

messageName - key of the notification to listen

observer - which listens for the notification

unsubscribe

void unsubscribe(String messageName,
                 NotificationObserver observer)

Removes an observer from the NotificationCenter.

Parameters:

messageName - key of the notification to remove

observer - which listens for the notification

unsubscribe

void unsubscribe(NotificationObserver observer)

Remove all registrations of an NotificationObserver.

Parameters:

observer - for remove all notifications

publish

void publish(String messageName,
             Object... payload)

Post a notification to all NotificationObserver which are registered with the given String. You can additionally add a varying number of Objects as a payload that the observer will receive.

Parameters:

messageName - of the notification which sould be send

payload - which should be passed

publish

void publish(Object channel,
             String messageName,
             Object[] payload)

Publishes a notification on a specific channel. The channel can be any object that can be distinguished by the equals method. Only subscribers that use the same channel object can receive the published message.

Parameters:

channel - a channel object.

messageName - of the notification

payload - to be send

subscribe

void subscribe(Object channel,
               String messageName,
               NotificationObserver observer)

Subscribe to a notification with a given NotificationObserver on a specific channel. See publish(Object, String, Object[]) for more information on channels.

Parameters:

channel - a channel object

messageName - of the Notification

observer - which should execute when the notification occurs

unsubscribe

void unsubscribe(Object channel,
                 String messageName,
                 NotificationObserver observer)

Removes a NotificationObserver for a given messageName.

Parameters:

channel -

messageName -

observer -

unsubscribe

void unsubscribe(Object channel,
                 NotificationObserver observer)

Removes a NotificationObserver for all messageName.

Parameters:

channel -

observer -