Class WeakMapChangeListener<K,V>
- javafx.collections.WeakMapChangeListener<K,V>
Type Parameters:
K - the key element type
All Implemented Interfaces:
public final class WeakMapChangeListener<K,V> extends Object implements MapChangeListener<K,V>, WeakListener
WeakMapChangeListener can be used, if an 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 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:
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface javafx.collections.MapChangeListener
MapChangeListener.Change<K,V>
-
-
Constructor Summary
Constructors Constructor and Description WeakMapChangeListener(MapChangeListener<K,V> listener)The constructor ofWeakMapChangeListener.
-
Method Summary
All MethodsInstance MethodsConcrete Methods Modifier and Type Method and Description voidonChanged(MapChangeListener.Change<? extends K,? extends V> change)Called after a change has been made to an ObservableMap.booleanwasGarbageCollected()Returnstrueif the linked listener was garbage-collected.
-
Constructor Detail
-
WeakMapChangeListener
public WeakMapChangeListener(MapChangeListener<K,V> listener)
The constructor ofWeakMapChangeListener.Parameters:
listener- The original listener that should be notified
-
-
Method Detail
-
wasGarbageCollected
public boolean wasGarbageCollected()
Returnstrueif the linked listener was garbage-collected. In this case, the listener can be removed from the observable.Specified by:
wasGarbageCollectedin interfaceWeakListenerReturns:
trueif the linked listener was garbage-collected.
-
onChanged
public void onChanged(MapChangeListener.Change<? extends K,? extends V> change)
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.Specified by:
onChangedin interfaceMapChangeListener<K,V>Parameters:
change- the change that was made
-
© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.