de.saxsys.mvvmfx.utils.notifications

Class DefaultNotificationCenter

java.lang.Object

de.saxsys.mvvmfx.utils.notifications.DefaultNotificationCenter

All Implemented Interfaces:

NotificationCenter

public class DefaultNotificationCenter
extends Object
implements NotificationCenter

Default implementation of NotificationCenter.

Author:

sialcasa

Constructor Summary

Constructors

Constructor and Description
DefaultNotificationCenter()

Method Summary

Modifier and Type	Method and Description
void	publish(Object channel, String messageName, Object[] payload) This notification will be send to the UI-Thread (if the UI-toolkit was bootstrapped).
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultNotificationCenter

public DefaultNotificationCenter()

Method Detail

subscribe

public void subscribe(String messageName,
                      NotificationObserver observer)

Description copied from interface: NotificationCenter

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.

Specified by:

subscribe in interface NotificationCenter

Parameters:

messageName - key of the notification to listen

observer - which listens for the notification

unsubscribe

public void unsubscribe(String messageName,
                        NotificationObserver observer)

Description copied from interface: NotificationCenter

Removes an observer from the NotificationCenter.

Specified by:

unsubscribe in interface NotificationCenter

Parameters:

messageName - key of the notification to remove

observer - which listens for the notification

unsubscribe

public void unsubscribe(NotificationObserver observer)

Description copied from interface: NotificationCenter

Remove all registrations of an NotificationObserver.

Specified by:

unsubscribe in interface NotificationCenter

Parameters:

observer - for remove all notifications

publish

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

Description copied from interface: NotificationCenter

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.

Specified by:

publish in interface NotificationCenter

Parameters:

messageName - of the notification which sould be send

payload - which should be passed

publish

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

This notification will be send to the UI-Thread (if the UI-toolkit was bootstrapped). If no UI-Toolkit is available the notification will be directly published. This is typically the case in unit tests.

Specified by:

publish in interface NotificationCenter

Parameters:

channel - the channel

messageName - the message to sent

payload - additional arguments to the message

subscribe

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

Description copied from interface: NotificationCenter

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

Specified by:

subscribe in interface NotificationCenter

Parameters:

channel - a channel object

messageName - of the Notification

observer - which should execute when the notification occurs

unsubscribe

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

Description copied from interface: NotificationCenter

Removes a NotificationObserver for a given messageName.

Specified by:

unsubscribe in interface NotificationCenter

unsubscribe

public void unsubscribe(Object channel,
                        NotificationObserver observer)

Description copied from interface: NotificationCenter

Removes a NotificationObserver for all messageName.

Specified by:

unsubscribe in interface NotificationCenter