Top Description Fields Constructors Methods
javafx.collections

public final Class WeakMapChangeListener<K, V>

extends Object
implements MapChangeListener<K, V>, WeakListener
Class Inheritance
All Implemented Interfaces
javafx.beans.WeakListener, javafx.collections.MapChangeListener
Type Parameters
<K>
the key element type
<V>
the value element type
Imports
javafx.beans.NamedArg, .WeakListener, java.lang.ref.WeakReference
A WeakMapChangeListener can be used, if an javafx.collections.ObservableMap should only maintain a weak reference to the listener. This helps to avoid memory leaks, that can occur if observers are not unregistered from observed objects after use.

WeakMapChangeListener are created by passing in the original javafx.collections.MapChangeListener. The WeakMapChangeListener should then be registered to listen for changes of the observed object.

Note

You have to keep a reference to the MapChangeListener, that was passed in as long as it is in use, otherwise it will be garbage collected to soon.

Since
JavaFX 2.1
See Also
MapChangeListener, ObservableMap, javafx.beans.WeakListener

Field Summary

Modifier and TypeField and Description
private final WeakReference<MapChangeListener<K, V>>
ref

Constructor Summary

AccessConstructor and Description
public
WeakMapChangeListener(MapChangeListener<K, V>
The original listener that should be notified
listener)

The constructor of WeakMapChangeListener.

Method Summary

Modifier and TypeMethod and Description
public void
onChanged(MapChangeListener.Change<? extends K, ? extends V>
the change that was made
change)

Implements javafx.collections.MapChangeListener.onChanged.

Called after a change has been made to an ObservableMap.

public boolean
wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

refback to summary
private final WeakReference<MapChangeListener<K, V>> ref

Constructor Detail

WeakMapChangeListenerback to summary
public WeakMapChangeListener(MapChangeListener<K, V> listener)

The constructor of WeakMapChangeListener.

Parameters
listener:MapChangeListener<K, V>

The original listener that should be notified

Method Detail

onChangedback to summary
public void onChanged(MapChangeListener.Change<? extends K, ? extends V> change)

Implements javafx.collections.MapChangeListener.onChanged.

Doc from javafx.collections.MapChangeListener.onChanged.

Called after a change has been made to an ObservableMap. This method is called on every elementary change (put/remove) once. This means, complex changes like keySet().removeAll(Collection) or clear() may result in more than one call of onChanged method.

Parameters
change:MapChangeListener.Change<? extends K, ? extends V>

the change that was made

Annotations
@Override
wasGarbageCollectedback to summary
public boolean wasGarbageCollected()

Implements javafx.beans.WeakListener.wasGarbageCollected.

Doc from javafx.beans.WeakListener.wasGarbageCollected.

Returns true if the linked listener was garbage-collected. In this case, the listener can be removed from the observable.

Returns:boolean

true if the linked listener was garbage-collected.

Annotations
@Override