Top Description Fields Constructors Methods
javafx.collections

public final Class WeakListChangeListener<E>

extends Object
implements ListChangeListener<E>, WeakListener
Class Inheritance
All Implemented Interfaces
javafx.beans.WeakListener, javafx.collections.ListChangeListener
Type Parameters
<E>
The type of the observed value
Imports
javafx.beans.NamedArg, .WeakListener, java.lang.ref.WeakReference
A WeakListChangeListener can be used, if an ObservableList 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.

WeakListChangeListener are created by passing in the original ListChangeListener. The WeakListChangeListener should then be registered to listen for changes of the observed object.

Note

You have to keep a reference to the ListChangeListener, 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
ListChangeListener, ObservableList, javafx.beans.WeakListener

Field Summary

Modifier and TypeField and Description
private final WeakReference<ListChangeListener<E>>
ref

Constructor Summary

AccessConstructor and Description
public
WeakListChangeListener(ListChangeListener<E>
The original listener that should be notified
listener)

The constructor of WeakListChangeListener.

Method Summary

Modifier and TypeMethod and Description
public void
onChanged(ListChangeListener.Change<? extends E>
an object representing the change that was done
change)

Implements javafx.collections.ListChangeListener.onChanged.

Called after a change has been made to an ObservableList.

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<ListChangeListener<E>> ref

Constructor Detail

WeakListChangeListenerback to summary
public WeakListChangeListener(ListChangeListener<E> listener)

The constructor of WeakListChangeListener.

Parameters
listener:ListChangeListener<E>

The original listener that should be notified

Method Detail

onChangedback to summary
public void onChanged(ListChangeListener.Change<? extends E> change)

Implements javafx.collections.ListChangeListener.onChanged.

Doc from javafx.collections.ListChangeListener.onChanged.

Called after a change has been made to an ObservableList.

Parameters
change:ListChangeListener.Change<? extends E>

an object representing the change that was done

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