RFR: 8294809: ListenerHelper for managing and disconnecting listeners [v10]
Andy Goryachev
angorya at openjdk.org
Mon Nov 14 20:23:09 UTC 2022
> Introduction
>
> There is a number of places where various listeners (strong as well as weak) are added, to be later disconnected in one go. For example, Skin implementations use dispose() method to clean up the listeners installed in the corresponding Control (sometimes using LambdaMultiplePropertyChangeListenerHandler class).
>
> This pattern is also used by app developers, but there is no public utility class to do that, so every one must invent their own, see for instance
> https://github.com/andy-goryachev/FxTextEditor/blob/master/src/goryachev/fx/FxDisconnector.java
>
> Proposal
>
> It might be beneficial to create a class (ListenerHelper, feel free to suggest a better name) which:
>
> - provides convenient methods like addChangeListener, addInvalidationListener, addWeakChangeListener, etc.
> - keeps track of the listeners and the corresponding ObservableValues
> - provides a single disconnect() method to remove all the listeners in one go.
> - optionally, it should be possible to add a lambda (Runnable) to a group of properties
> - optionally, there should be a boolean flag to fire the lambda immediately
> - strongly suggest implementing an IDisconnectable functional interface with a single disconnect() method
>
> Make it Public Later
>
> Initially, I think we could place the new class in package com.sun.javafx.scene.control; to be made publicly accessible later.
>
> Where It Will Be Useful
>
> [JDK-8294589](https://bugs.openjdk.org/browse/JDK-8294589) "MenuBarSkin: memory leak when changing skin"
> and other skins, as a replacement for LambdaMultiplePropertyChangeListenerHandler.
>
> https://github.com/openjdk/jfx/pull/908#:~:text=19%20hours%20ago-,8295175%3A%20SplitPaneSkinSkin%3A%20memory%20leak%20when%20changing%20skin%20%23911,-Draft
>
> https://github.com/openjdk/jfx/pull/914
Andy Goryachev has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 26 additional commits since the last revision:
- 8294809: review comments
- Merge remote-tracking branch 'origin/master' into 8294809.listener.helper
- 8294809: review comments
- Merge remote-tracking branch 'origin/master' into 8294809.listener.helper
- 8294809: whitespace
- 8294809: no public api
- 8294809: map change listener
- Merge remote-tracking branch 'origin/master' into 8294809.listener.helper
- 8294809: generics
- 8294809: is alive
- ... and 16 more: https://git.openjdk.org/jfx/compare/a47e8f3e...2a295c24
-------------
Changes:
- all: https://git.openjdk.org/jfx/pull/908/files
- new: https://git.openjdk.org/jfx/pull/908/files/470f42c1..2a295c24
Webrevs:
- full: https://webrevs.openjdk.org/?repo=jfx&pr=908&range=09
- incr: https://webrevs.openjdk.org/?repo=jfx&pr=908&range=08-09
Stats: 1962 lines in 134 files changed: 1588 ins; 292 del; 82 mod
Patch: https://git.openjdk.org/jfx/pull/908.diff
Fetch: git fetch https://git.openjdk.org/jfx pull/908/head:pull/908
PR: https://git.openjdk.org/jfx/pull/908
More information about the openjfx-dev
mailing list