Deprecate TypedListener for removal to make it strongly internal later

eclipse-platform · Nov 28, 2024 · cfa74b4 · cfa74b4
1 parent fa71076
commit cfa74b4
Show file tree

Hide file tree

Showing 8 changed files with 16 additions and 1 deletion.
diff --git a/....eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java b/....eclipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/DefaultContent.java
@@ -749,6 +749,7 @@ public String getTextRange(int start, int length) {
  * </ul>
  */
 @Override
+@SuppressWarnings("removal")
 public void removeTextChangeListener(TextChangeListener listener){
 	if (listener == null) error(SWT.ERROR_NULL_ARGUMENT);
 	for (int i = 0; i < textListeners.size(); i++) {

diff --git a/...ipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextListener.java b/...ipse.swt/Eclipse SWT Custom Widgets/common/org/eclipse/swt/custom/StyledTextListener.java
@@ -17,6 +17,7 @@
 import org.eclipse.swt.internal.*;
 import org.eclipse.swt.widgets.*;
 
+@SuppressWarnings("removal")
 class StyledTextListener extends TypedListener {
 StyledTextListener(SWTEventListener listener) {
 	super(listener);

diff --git a/...les/org.eclipse.swt/Eclipse SWT Drag and Drop/common/org/eclipse/swt/dnd/DNDListener.java b/...les/org.eclipse.swt/Eclipse SWT Drag and Drop/common/org/eclipse/swt/dnd/DNDListener.java
@@ -16,7 +16,7 @@
 import org.eclipse.swt.internal.*;
 import org.eclipse.swt.widgets.*;
 
-
+@SuppressWarnings("removal")
 class DNDListener extends TypedListener {
 	Widget dndWidget;
 /**

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Widget.java b/bundles/org.eclipse.swt/Eclipse SWT/cocoa/org/eclipse/swt/widgets/Widget.java
@@ -500,6 +500,7 @@ protected void addTypedListener (EventListener listener, int... eventTypes) {
 	if (listener == null) {
 		SWT.error(SWT.ERROR_NULL_ARGUMENT);
 	}
+	@SuppressWarnings("removal")
 	TypedListener typedListener = new TypedListener(listener);
 	for (int eventType : eventTypes) {
 		_addListener(eventType, typedListener);
@@ -1028,6 +1029,7 @@ public Listener[] getListeners (int eventType) {
  *
  * @since 3.126
  */
+@SuppressWarnings("removal")
 public <L extends EventListener> Stream<L> getTypedListeners (int eventType, Class<L> listenerType) {
 	return Arrays.stream(getListeners(eventType)) //
 			.filter(TypedListener.class::isInstance).map(l -> ((TypedListener) l).eventListener)

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/EventTable.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/EventTable.java
@@ -147,6 +147,7 @@ public void unhook (int eventType, Listener listener) {
 	}
 }
 
+@SuppressWarnings("removal")
 public void unhook (int eventType, EventListener listener) {
 	if (types == null) return;
 	for (int i=0; i<types.length; i++) {

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java b/bundles/org.eclipse.swt/Eclipse SWT/common/org/eclipse/swt/widgets/TypedListener.java
@@ -36,7 +36,13 @@
  * @noreference This class is not intended to be referenced by clients.
  * @noextend This class is not intended to be subclassed by clients.
  * @noinstantiate This class is not intended to be instantiated by clients.
+ * @deprecated This class will become 'strongly' internal. For custom widgets
+ *             {@link Widget#addTypedListener(EventListener, int...)},
+ *             {@link Widget#getTypedListeners(int, Class)} or
+ *             {@link Widget#removeTypedListener(int, EventListener)} can
+ *             probably be used instead.
  */
+@Deprecated(forRemoval = true, since = "3.129.0 (removal in 2027-03 or later)")
 public class TypedListener implements Listener {
 
 	/**

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Widget.java b/bundles/org.eclipse.swt/Eclipse SWT/gtk/org/eclipse/swt/widgets/Widget.java
@@ -361,6 +361,7 @@ protected void addTypedListener (EventListener listener, int... eventTypes) {
 	if (listener == null) {
 		SWT.error(SWT.ERROR_NULL_ARGUMENT);
 	}
+	@SuppressWarnings("removal")
 	TypedListener typedListener = new TypedListener(listener);
 	for (int eventType : eventTypes) {
 		_addListener(eventType, typedListener);
@@ -730,6 +731,7 @@ public Listener[] getListeners (int eventType) {
  *
  * @since 3.126
  */
+@SuppressWarnings("removal")
 public <L extends EventListener> Stream<L> getTypedListeners (int eventType, Class<L> listenerType) {
 	return Arrays.stream(getListeners(eventType)) //
 			.filter(TypedListener.class::isInstance).map(l -> ((TypedListener) l).eventListener)

diff --git a/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java b/bundles/org.eclipse.swt/Eclipse SWT/win32/org/eclipse/swt/widgets/Widget.java
@@ -256,6 +256,7 @@ protected void addTypedListener (EventListener listener, int... eventTypes) {
 	if (listener == null) {
 		SWT.error(SWT.ERROR_NULL_ARGUMENT);
 	}
+	@SuppressWarnings("removal")
 	TypedListener typedListener = new TypedListener(listener);
 	for (int eventType : eventTypes) {
 		_addListener(eventType, typedListener);
@@ -668,6 +669,7 @@ public Listener[] getListeners (int eventType) {
  *
  * @since 3.126
  */
+@SuppressWarnings("removal")
 public <L extends EventListener> Stream<L> getTypedListeners (int eventType, Class<L> listenerType) {
 	return Arrays.stream(getListeners(eventType)) //
 			.filter(TypedListener.class::isInstance).map(l -> ((TypedListener) l).eventListener)