org.gradle.foundation.common

Class ObserverLord<E>

java.lang.Object

org.gradle.foundation.common.ObserverLord<E>

public class ObserverLord<E>
extends Object

This is a Swing-friendly observer manager class. Swing-friendly, but can be used by non-Swing classes. Its meant to abstract the fact that you probably need to be in the Event Dispatch Thread when receiving notifications inside Swing-related classes. To use this class, add it as a member variable (don't derive from this!) of a class that you want to be observered. You can have multiple instances of this if you want to allow for a finer granularity of observing (similar to components having mouse move listeners and mouse (click) listeners). Next, create an interface for the observers. Now implement add and remove observer functions that call the add and remove functions here. Lastly, implement ObserverNotification and have it call the aforementioned observer interface appropriately. Note: you should actually implement ObserverNotification for each "message" you want to send. Example: One that would tell a view a node was added. One that would tell a view a node was deleted, etc. While you have multiple notification classes, you only need 1 (or few) actual observer interfaces, containing all the possible functions called by all notifications.

Author:

mhunsicker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ObserverLord.ObserverNotification<E> Implement this for each call to ObserverLord.notifyObservers.

Constructor Summary

Constructors

Constructor and Description
ObserverLord()

Method Summary

Methods

Modifier and Type	Method and Description
void	addObserver(E observer, boolean inEventQueue) Adds an observer to our messaging system.
void	notifyObservers(ObserverLord.ObserverNotification<E> notification) Messaging method that handles telling each observer that something happen to the observable.
void	removeAllObservers()
void	removeObserver(E observer) Deletes an observer in our messaging system.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObserverLord

public ObserverLord()

Method Detail

addObserver

public void addObserver(E observer,
               boolean inEventQueue)

Adds an observer to our messaging system.

Parameters:

observer - observer to add.

inEventQueue - true to notify this observer only in the event queue, false to notify it immediately.

removeObserver

public void removeObserver(E observer)

Deletes an observer in our messaging system.

Parameters:

observer - in,

removeAllObservers

public void removeAllObservers()

notifyObservers

public void notifyObservers(ObserverLord.ObserverNotification<E> notification)

Messaging method that handles telling each observer that something happen to the observable.

Parameters:

notification - in, notification sent to the observer

toString

public String toString()

Overrides:

toString in class Object