Notifier Class
A Base INotifier implementation.
MacroCommand, SimpleCommand, Mediator, and Proxy
all have a need to send Notifications.
The INotifier interface provides a common method called sendNotification that relieves implementation code of the necessity to actually construct INotifications.
The Notifier class, which all of the above mentioned classes extend, provides an initialized reference to an IFacade Multiton, which is required by the convienience method for sending INotifications, but also eases implementation as these classes have frequent Facade interactions and usually require access to the facade anyway.
NOTE: In the MultiCore version of the framework, there is one caveat to Notifiers, they cannot send notifications or reach the facade until they have a valid multitonKey.
The multitonKey is set: * on a ICommand when it is instantiated by the Controller * on a IMediator when it is registered with the IView * on a IProxy when it is registered with the IModel
See Proxy, Facade, Mediator, MacroCommand, SimpleCommand
Subclasses
MacroCommand, Mediator, Proxy, SimpleCommand
Implements
Constructors
Code new Notifier() #
Notifier(){
}
Methods
Code IFacade get facade() #
Return the Multiton Facade instance - Throws MultitonErrorNotifierLacksKey if no multitonKey is set. Usually means facade getter is being accessed before initializeNotifier has been called (i.e., from the constructor). Defer facade access until the onRegister method.
IFacade get facade()
{
if ( multitonKey == null ) throw new MultitonNotifierLacksKey( );
return Facade.getInstance( multitonKey );
}
Code void initializeNotifier(String key) #
Initialize this INotifier instance.
This is how a INotifier gets its multitonKey. Calls to sendNotification or access to the facade will fail until after this method has been called.
- Param key - the Multiton key for this INotifier.
void initializeNotifier( String key )
{
multitonKey = key;
}
Code void sendNotification(String noteName, [body, String type]) #
Send an INotification.
Convenience method to prevent having to construct new INotification instances in our implementation code.
- Param noteName the name of the note to send
- Param body - the body of the note (optional)
- Param type - the type of the note (optional)
void sendNotification( String noteName, [Dynamic body, String type] )
{
if (facade != null)
facade.sendNotification( noteName, body, type );
}