Use new @IContextFunction.ServiceContextKey component property type

HannesWell · HannesWell · commit 662929bf5557 · 2024-10-15T19:29:53.000+02:00
and @org.osgi.service.event.propertytypes.EventTopics where applicable.
diff --git a/bundles/org.eclipse.e4.core.commands/.settings/org.eclipse.pde.ds.annotations.prefs b/bundles/org.eclipse.e4.core.commands/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -1,4 +1,4 @@
-dsVersion=V1_3
+dsVersion=V1_4
 eclipse.preferences.version=1
 enabled=true
 generateBundleActivationPolicyLazy=true
diff --git a/bundles/org.eclipse.e4.core.commands/src/org/eclipse/e4/core/commands/internal/CommandServiceCreationFunction.java b/bundles/org.eclipse.e4.core.commands/src/org/eclipse/e4/core/commands/internal/CommandServiceCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2014 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -21,7 +21,8 @@
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.commands.ECommandService")
+@Component(service = IContextFunction.class )
+@IContextFunction.ServiceContextKey(org.eclipse.e4.core.commands.ECommandService.class)
 public class CommandServiceCreationFunction extends ContextFunction {
 	/**
 	 * A context key (value "rootContext") that identifies the root of this context chain. It does
diff --git a/bundles/org.eclipse.e4.core.commands/src/org/eclipse/e4/core/commands/internal/HandlerServiceCreationFunction.java b/bundles/org.eclipse.e4.core.commands/src/org/eclipse/e4/core/commands/internal/HandlerServiceCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2013 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -20,7 +20,8 @@
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.commands.EHandlerService")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.e4.core.commands.EHandlerService.class)
 public class HandlerServiceCreationFunction extends ContextFunction {
 
 	@Override
diff --git a/bundles/org.eclipse.e4.ui.bindings/.settings/org.eclipse.pde.ds.annotations.prefs b/bundles/org.eclipse.e4.ui.bindings/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -1,4 +1,4 @@
-dsVersion=V1_3
+dsVersion=V1_4
 eclipse.preferences.version=1
 enabled=true
 generateBundleActivationPolicyLazy=true
diff --git a/bundles/org.eclipse.e4.ui.bindings/src/org/eclipse/e4/ui/bindings/internal/BindingServiceCreationFunction.java b/bundles/org.eclipse.e4.ui.bindings/src/org/eclipse/e4/ui/bindings/internal/BindingServiceCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2014 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -20,7 +20,8 @@
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.ui.bindings.EBindingService")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.e4.ui.bindings.EBindingService.class)
 public class BindingServiceCreationFunction extends ContextFunction {
 
 	@Override
diff --git a/bundles/org.eclipse.e4.ui.services/.settings/org.eclipse.pde.ds.annotations.prefs b/bundles/org.eclipse.e4.ui.services/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -1,4 +1,4 @@
-dsVersion=V1_3
+dsVersion=V1_4
 eclipse.preferences.version=1
 enabled=true
 generateBundleActivationPolicyLazy=true
diff --git a/bundles/org.eclipse.e4.ui.services/src/org/eclipse/e4/ui/services/events/EventBrokerFactory.java b/bundles/org.eclipse.e4.ui.services/src/org/eclipse/e4/ui/services/events/EventBrokerFactory.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2016 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -23,12 +23,11 @@
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.event.EventAdmin;
 
-
-
 /**
  * Use this class to obtain an instance of {@link IEventBroker}.
  */
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.services.events.IEventBroker")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(IEventBroker.class)
 public class EventBrokerFactory extends ContextFunction {
 
 	// mandatory static reference to EventAdmin to ensure it is available before
@@ -50,4 +49,3 @@ public Object compute(IEclipseContext context, String contextKey) {
 		return broker;
 	}
 }
-
diff --git a/bundles/org.eclipse.e4.ui.workbench.swt/.settings/org.eclipse.pde.ds.annotations.prefs b/bundles/org.eclipse.e4.ui.workbench.swt/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -1,5 +1,5 @@
 classpath=true
-dsVersion=V1_3
+dsVersion=V1_4
 eclipse.preferences.version=1
 enabled=true
 generateBundleActivationPolicyLazy=true
diff --git a/bundles/org.eclipse.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/MenuServiceCreationFunction.java b/bundles/org.eclipse.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/MenuServiceCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2016 IBM Corporation and others.
+ * Copyright (c) 2010, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -20,7 +20,8 @@
 import org.eclipse.e4.core.di.InjectionException;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.ui.services.EMenuService")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.e4.ui.services.EMenuService.class)
 public class MenuServiceCreationFunction extends ContextFunction {
 
 	@Override
diff --git a/bundles/org.eclipse.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/StatusReporterCreationFunction.java b/bundles/org.eclipse.e4.ui.workbench.swt/src/org/eclipse/e4/ui/internal/workbench/swt/StatusReporterCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2016 IBM Corporation and others.
+ * Copyright (c) 2010, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -19,13 +19,13 @@
 import org.eclipse.e4.core.contexts.IEclipseContext;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.services.statusreporter.StatusReporter")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.e4.core.services.statusreporter.StatusReporter.class)
 public class StatusReporterCreationFunction extends ContextFunction {
 
 	@Override
 	public Object compute(IEclipseContext context, String contextKey) {
-		return ContextInjectionFactory.make(WorkbenchStatusReporter.class,
-				context);
+		return ContextInjectionFactory.make(WorkbenchStatusReporter.class, context);
 	}
 
 }
diff --git a/bundles/org.eclipse.e4.ui.workbench/.settings/org.eclipse.pde.ds.annotations.prefs b/bundles/org.eclipse.e4.ui.workbench/.settings/org.eclipse.pde.ds.annotations.prefs
@@ -1,5 +1,5 @@
 classpath=true
-dsVersion=V1_3
+dsVersion=V1_4
 eclipse.preferences.version=1
 enabled=true
 generateBundleActivationPolicyLazy=true
diff --git a/bundles/org.eclipse.e4.ui.workbench/META-INF/MANIFEST.MF b/bundles/org.eclipse.e4.ui.workbench/META-INF/MANIFEST.MF
@@ -37,7 +37,8 @@ Export-Package: org.eclipse.e4.ui.internal.workbench;
 Bundle-Activator: org.eclipse.e4.ui.internal.workbench.Activator
 Import-Package: jakarta.annotation;version="[2.1.0,3.0.0)",
  jakarta.inject;version="[2.0.0,3.0.0)",
- org.osgi.service.event;version="[1.3.0,2.0.0)"
+ org.osgi.service.event;version="[1.3.0,2.0.0)",
+ org.osgi.service.event.propertytypes;version="[1.4.0,2.0.0)"
 Require-Capability: osgi.extender;
   filter:="(&(osgi.extender=osgi.component)(version>=1.2)(!(version>=2.0)))",
  osgi.service;
diff --git a/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/LocaleChangeServiceContextFunction.java b/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/LocaleChangeServiceContextFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2013, 2016 Dirk Fauth and others.
+ * Copyright (c) 2013, 2024 Dirk Fauth and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -24,13 +24,13 @@
 /**
  * Context function to provide the LocaleChangeServiceImpl to the application context.
  */
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.services.nls.ILocaleChangeService")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(ILocaleChangeService.class)
 public class LocaleChangeServiceContextFunction extends ContextFunction {
 
 	@Override
 	public Object compute(IEclipseContext context, String contextKey) {
-		ILocaleChangeService lcService = ContextInjectionFactory.make(
-				LocaleChangeServiceImpl.class, context);
+		ILocaleChangeService lcService = ContextInjectionFactory.make(LocaleChangeServiceImpl.class, context);
 
 		// add the new object to the application context
 		MApplication application = context.get(MApplication.class);
diff --git a/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/ExtensionTrackeContextFunction.java b/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/ExtensionTrackeContextFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2022 Christoph Läubrich and others.
+ * Copyright (c) 2022, 2024 Christoph Läubrich and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -27,10 +27,11 @@
 import org.osgi.service.component.annotations.Reference;
 import org.osgi.service.event.Event;
 import org.osgi.service.event.EventHandler;
+import org.osgi.service.event.propertytypes.EventTopics;
 
-@Component(service = IContextFunction.class, property = {
-		"service.context.key=org.eclipse.core.runtime.dynamichelpers.IExtensionTracker",
-		"event.topics=" + IEclipseContext.TOPIC_DISPOSE })
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(IExtensionTracker.class)
+@EventTopics(IEclipseContext.TOPIC_DISPOSE)
 public class ExtensionTrackeContextFunction extends ContextFunction implements EventHandler {
 
 	@Reference
diff --git a/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/PartServiceCreationFunction.java b/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/PartServiceCreationFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2016 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -24,7 +24,8 @@
 import org.eclipse.e4.ui.model.application.ui.basic.MWindow;
 import org.osgi.service.component.annotations.Component;
 
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.ui.workbench.modeling.EPartService")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.e4.ui.workbench.modeling.EPartService.class)
 public class PartServiceCreationFunction extends ContextFunction {
 
 	@Override
diff --git a/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/ProgressMonitorFunction.java b/bundles/org.eclipse.e4.ui.workbench/src/org/eclipse/e4/ui/internal/workbench/ProgressMonitorFunction.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2009, 2016 IBM Corporation and others.
+ * Copyright (c) 2009, 2024 IBM Corporation and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -24,7 +24,8 @@
  * used near the root of a context tree to provide a reasonable default monitor for cases where more
  * specific contexts have not provided one.
  */
-@Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.core.runtime.IProgressMonitor")
+@Component(service = IContextFunction.class)
+@IContextFunction.ServiceContextKey(org.eclipse.core.runtime.IProgressMonitor.class)
 public class ProgressMonitorFunction extends ContextFunction {
 
 	@Override
diff --git a/docs/Eclipse4_RCP_Contexts.md b/docs/Eclipse4_RCP_Contexts.md
@@ -194,7 +194,8 @@ These contexts — and the services requested — are bounded by the lifecycle o
 This approach exposes a context function as the implementation of a service defined OSGi Declarative Services. 
 This pattern is used for creating the _IEventBroker_, using the new DS annotations support.
 
-    @Component(service = IContextFunction.class, property = "service.context.key=org.eclipse.e4.core.services.events.IEventBroker")
+    @Component(service = IContextFunction.class)
+    @IContextFunction.ServiceContextKey(org.eclipse.e4.core.services.events.IEventBroker.class)
     public class EventBrokerFactory extends ContextFunction {
         @Override
         public Object compute(IEclipseContext context, String contextKey) {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-dsVersion=V1_3`
	`1`	`+dsVersion=V1_4`
`2`	`2`	`eclipse.preferences.version=1`
`3`	`3`	`enabled=true`
`4`	`4`	`generateBundleActivationPolicyLazy=true`