net.shredzone.jshred.swing

Class ListenerManager<T extends EventListener>

java.lang.Object

net.shredzone.jshred.swing.ListenerManager<T>

public class ListenerManager<T extends EventListener>
extends Object

A ListenerManager helps you keep track of EventListener lists. The speciality of this manager is to store the listeners weakly, so you won't need to remove the listeners before you destroy the receiver object.

Since:

R15

Author:

Richard "Shred" Körber

Constructor Summary

Constructors

Constructor and Description
ListenerManager()

Method Summary

Modifier and Type	Method and Description
void	addListener(T listener) Adds a listener to this manager.
Collection<T>	getListeners() Gets a Collection of all current listeners.
void	removeAllListeners() Removes all listeners from this manager.
void	removeListener(T listener) Removes the listener from this manager.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListenerManager

public ListenerManager()

Method Detail

addListener

public void addListener(T listener)

Adds a listener to this manager. If the listener was already added, nothing will happen.

Parameters:

listener - Listener to be added

removeListener

public void removeListener(T listener)

Removes the listener from this manager. If the listener was not added, nothing will happen.

Parameters:

listener - Listener to be removed

getListeners

public Collection<T> getListeners()

Gets a Collection of all current listeners. This collection is for immediate use only and must not be stored. If a listener is removed after this method was invoked, it will still be present in the result collection. Also, storing the result collection will keep a reference to the listeners and will render the weak reference mechanism useless.

Example for proper usage:

 for (ActionListener listener : manager.getListeners()) {
     listener.actionPerformed(event);
 }
 

The listeners are returned in no special order.

Returns:

Collection of all current listeners.

removeAllListeners

public void removeAllListeners()

Removes all listeners from this manager.