Package org.puremvc.java.interfaces

Interface IObserver

All Known Implementing Classes:
Observer
public interface IObserver

The interface definition for a PureMVC Observer.

In PureMVC, IObserver implementors assume these responsibilities:

  • Encapsulate the notification (callback) method of the interested object.
  • Encapsulate the notification context (this) of the interested object.
  • Provide methods for setting the interested object' notification method and context.
  • Provide a method for notifying the interested object.

PureMVC does not rely upon underlying event models such as the one provided with Flash, and ActionScript 3 does not have an inherent event model.

The Observer Pattern as implemented within PureMVC exists to support event driven communication between the application and the actors of the MVC triad.

An Observer is an object that encapsulates information about an interested object with a notification method that should be called when an INotification is broadcast. The Observer then acts as a proxy for notifying the interested object.

Observers can receive Notifications by having their notifyObserver method invoked, passing in an object implementing the INotification interface, such as a subclass of Notification.

See Also:
IView, INotification

  • Method Summary

    Modifier and Type Method Description
    boolean compareNotifyContext​(java.lang.Object object)
    Compare the given object to the notification context object.
    void notifyObserver​(INotification notification)
    Notify the interested object.
    void setNotifyContext​(java.lang.Object notifyContext)
    Set the notification context.
    void setNotifyMethod​(java.util.function.Consumer<INotification> notifyMethod)
    Set the notification method.

  • Method Details

    • setNotifyMethod

      void setNotifyMethod​(java.util.function.Consumer<INotification> notifyMethod)

      Set the notification method.

      The notification method should take one parameter of type INotification

      Parameters:
      notifyMethod - the notification (callback) method of the interested object

    • setNotifyContext

      void setNotifyContext​(java.lang.Object notifyContext)

      Set the notification context.

      Parameters:
      notifyContext - the notification context (this) of the interested object

    • notifyObserver

      void notifyObserver​(INotification notification)

      Notify the interested object.

      Parameters:
      notification - the INotification to pass to the interested object's notification method

    • compareNotifyContext

      boolean compareNotifyContext​(java.lang.Object object)

      Compare the given object to the notification context object.

      Parameters:
      object - the object to compare.
      Returns:
      boolean indicating if the notification context and the object are the same.