de.saxsys.mvvmfx.utils.listener

Class ListenerManager

java.lang.Object

de.saxsys.mvvmfx.utils.listener.ListenerManager

All Implemented Interfaces:

ICleanable

public class ListenerManager
extends Object
implements ICleanable

The ListenerManager is used to be able to clean up listeners when they are not used anymore. A typical use case is a component that registers some listeners to its properties. When the component isn't used anymore the listeners needs to be removed from the properties. Otherwise it could lead to memory leaks as the garbage collector can't delete the objects as there are still references available. With the ListenerManager you can reduce the possibility to forget a listener because all listeners can be removed with one single method clean().

Author:

manuel.mauky

Constructor Summary

Constructors

Constructor and Description
ListenerManager()

Method Summary

Modifier and Type	Method and Description
void	clean() Clean logic for a component.
void	register(javafx.beans.Observable observable, javafx.beans.InvalidationListener listener) Register the given InvalidationListener to the Observable .
<T> void	register(javafx.collections.ObservableList<T> observable, javafx.collections.ListChangeListener<? super T> listener) Register the given ListChangeListener to the ObservableList.
<T> void	register(javafx.beans.value.ObservableValue<T> observable, javafx.beans.value.ChangeListener<? super T> listener) Register the given ChangeListener to the ObservableValue.

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

register

public <T> void register(javafx.beans.value.ObservableValue<T> observable,
                         javafx.beans.value.ChangeListener<? super T> listener)

Register the given ChangeListener to the ObservableValue. The listener is added to the observable and will be added for management so it can be cleaned up with the clean() method.

Type Parameters:

T - the generic type of the observable value.

Parameters:

observable - the observable that the listener is added to.

listener - the listener that is registered.

register

public <T> void register(javafx.collections.ObservableList<T> observable,
                         javafx.collections.ListChangeListener<? super T> listener)

Register the given ListChangeListener to the ObservableList. The listener is added to the observable and will be added for management so it can be cleaned up with the clean() method.

Type Parameters:

T - the generic type of the observable list.

Parameters:

observable - the observable list that the listener is added to.

listener - the listener that is registered.

register

public void register(javafx.beans.Observable observable,
                     javafx.beans.InvalidationListener listener)

Register the given InvalidationListener to the Observable . The listener is added to the observable and will be added for management so it can be cleaned up with the clean() method.

Parameters:

observable - the observable that the listener is added to.

listener - the listener that is registered.

clean

public void clean()

Description copied from interface: ICleanable

Clean logic for a component.

Specified by:

clean in interface ICleanable