[E4 XPath] Deprecate unsuitable XPathContextFactory methods for removal

Author: HannesWell

bundles/org.eclipse.e4.emf.xpath/.settings/.api_filters

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<component id="org.eclipse.e4.emf.xpath" version="2">
+    <resource path="src/org/eclipse/e4/emf/xpath/XPathContextFactory.java" type="org.eclipse.e4.emf.xpath.XPathContextFactory">
+        <filter id="422776937">
+            <message_arguments>
+                <message_argument value="org.eclipse.e4.emf.xpath.XPathContextFactory.newInstance()"/>
+                <message_argument value="T"/>
+            </message_arguments>
+        </filter>
+    </resource>
+</component>

bundles/org.eclipse.e4.emf.xpath/META-INF/MANIFEST.MF

@@ -1,7 +1,7 @@
 Manifest-Version: 1.0
 Bundle-ManifestVersion: 2
 Bundle-Name: %Bundle-Name
-Bundle-SymbolicName: org.eclipse.e4.emf.xpath
+Bundle-SymbolicName: org.eclipse.e4.emf.xpath;deprecated:="This bundle is deprecated since 2025-03 (removal in 2027-03 or later)"
 Bundle-Version: 0.6.0.qualifier
 Bundle-RequiredExecutionEnvironment: JavaSE-17
 Require-Bundle: org.eclipse.emf.ecore;bundle-version="2.35.0",

bundles/org.eclipse.e4.emf.xpath/src/org/eclipse/e4/emf/xpath/EcoreXPathContextFactory.java

@@ -13,14 +13,14 @@
  ******************************************************************************/
 package org.eclipse.e4.emf.xpath;
 
-import org.eclipse.e4.emf.xpath.internal.java.JavaXPathContextFactoryImpl;
 import org.eclipse.emf.ecore.EObject;
 
 /**
  * Factory which creates an XPathContextFactory for {@link EObject}s
  *
  * @since 1.0
  */
+@Deprecated(forRemoval = true, since = "2025-03 (removal in 2027-03 or later)")
 public class EcoreXPathContextFactory {
 
 	/**
@@ -29,7 +29,7 @@ public class EcoreXPathContextFactory {
 	 * @return the factory
 	 */
 	public static XPathContextFactory<EObject> newInstance() {
-		return new JavaXPathContextFactoryImpl<>();
+		return XPathContextFactory.newInstance();
 	}
 
 }

bundles/org.eclipse.e4.emf.xpath/src/org/eclipse/e4/emf/xpath/XPathContext.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2024 BestSolution.at and others.
+ * Copyright (c) 2010, 2025 BestSolution.at and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -34,6 +34,7 @@ public interface XPathContext {
 	 *            to evaluate
 	 * @return Object found
 	 */
+	@Deprecated(forRemoval = true, since = "2025-03 (removal in 2027-03 or later)")
 	Object getValue(String xpath);
 
 	/**
@@ -46,6 +47,7 @@ public interface XPathContext {
 	 *            required type
 	 * @return Object found
 	 */
+	@Deprecated(forRemoval = true, since = "2025-03 (removal in 2027-03 or later)")
 	<T> T getValue(String xpath, Class<T> requiredType);
 
 	/**

bundles/org.eclipse.e4.emf.xpath/src/org/eclipse/e4/emf/xpath/XPathContextFactory.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2010, 2024 BestSolution.at and others.
+ * Copyright (c) 2010, 2025 BestSolution.at and others.
  *
  * This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License 2.0
@@ -14,6 +14,7 @@
 package org.eclipse.e4.emf.xpath;
 
 import org.eclipse.e4.emf.xpath.internal.java.JavaXPathContextFactoryImpl;
+import org.eclipse.emf.ecore.EObject;
 
 /**
  * Factory responsible to create an XPath-Context
@@ -38,14 +39,19 @@ public abstract class XPathContextFactory<T> {
 	 * @param parentContext parent context
 	 * @param contextBean   Object
 	 * @return XPathContext
+	 * @deprecated The parent-context does not provide any real value. Just use
+	 *             {@link #newContext(Object)}
 	 */
+	@Deprecated(forRemoval = true, since = "2025-03 (removal in 2027-03 or later)")
 	public abstract XPathContext newContext(XPathContext parentContext, T contextBean);
 
 	/**
-	 * @param <T> the object type the xpath is created for
-	 * @return Create a new XPath-Factory
+	 * Creates a new {@link XPathContextFactory XPathContextFactory<EObject>} that's
+	 * suitable to query the E4-model.
+	 *
+	 * @return A new {@code XPathContextFactory}.
 	 */
-	public static <T> XPathContextFactory<T> newInstance() {
-		return new JavaXPathContextFactoryImpl<>();
+	public static XPathContextFactory<EObject> newInstance() {
+		return new JavaXPathContextFactoryImpl();
 	}
 }

bundles/org.eclipse.e4.emf.xpath/src/org/eclipse/e4/emf/xpath/internal/java/JavaXPathContextFactoryImpl.java

@@ -57,20 +57,17 @@
 import org.w3c.dom.Node;
 import org.w3c.dom.NodeList;
 
-public class JavaXPathContextFactoryImpl<T> extends XPathContextFactory<T> {
+public class JavaXPathContextFactoryImpl extends XPathContextFactory<EObject> {
 
 	private static final XPathFactory XPATH_FACTORY = XPathFactory.newInstance();
 
 	@Override
-	public XPathContext newContext(T contextBean) {
+	public XPathContext newContext(EObject contextBean) {
 		return newContext(null, contextBean);
 	}
 
 	@Override
-	public XPathContext newContext(XPathContext parentContext, T contextBean) {
-		if (!(contextBean instanceof EObject rootObject)) {
-			throw new IllegalArgumentException();
-		}
+	public XPathContext newContext(XPathContext parentContext, EObject contextBean) {
 		XPath xpath;
 		DOMMapping domMapping;
 		Element rootElement = null;
@@ -95,7 +92,7 @@ public XPathContext newContext(XPathContext parentContext, T contextBean) {
 			Document document = documentBuilder.newDocument();
 
 			domMapping = new DOMMapping();
-			rootElement = createElement(rootObject, document, domMapping);
+			rootElement = createElement(contextBean, document, domMapping);
 			xpath.setNamespaceContext(createNamespaceContext(rootElement));
 		}
 		return new EObjectContext(rootElement, domMapping, xpath);

bundles/org.eclipse.e4.ui.model.workbench/src/org/eclipse/e4/ui/model/fragment/impl/StringModelFragmentImpl.java

@@ -18,7 +18,6 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.regex.Pattern;
-import org.eclipse.e4.emf.xpath.EcoreXPathContextFactory;
 import org.eclipse.e4.emf.xpath.XPathContext;
 import org.eclipse.e4.emf.xpath.XPathContextFactory;
 import org.eclipse.e4.ui.model.application.MApplication;
@@ -355,7 +354,7 @@ private void mergeXPath(MApplication application, List<MApplicationElement> ret,
 		if ("/".equals(xPath)) {
 			targetElements = List.of(application);
 		} else {
-			XPathContextFactory<EObject> f = EcoreXPathContextFactory.newInstance();
+			XPathContextFactory<EObject> f = XPathContextFactory.newInstance();
 			XPathContext xpathContext = f.newContext((EObject) application);
 			try {
 				targetElements = xpathContext.stream(xPath, MApplicationElement.class).toList();

tests/org.eclipse.e4.emf.xpath.test/src/org/eclipse/e4/emf/xpath/test/ExampleQueriesApplicationTest.java

@@ -19,7 +19,6 @@
 
 import java.util.List;
 
-import org.eclipse.e4.emf.xpath.EcoreXPathContextFactory;
 import org.eclipse.e4.emf.xpath.XPathContext;
 import org.eclipse.e4.emf.xpath.XPathContextFactory;
 import org.eclipse.e4.ui.internal.workbench.E4XMIResourceFactory;
@@ -69,11 +68,11 @@ public void setUp() {
 
 		URI uri = URI.createPlatformPluginURI("/org.eclipse.e4.emf.xpath.test/model/Application.e4xmi", true);
 		resource = resourceSet.getResource(uri, true);
-		XPathContextFactory<EObject> f = EcoreXPathContextFactory.newInstance();
+		XPathContextFactory<EObject> f = XPathContextFactory.newInstance();
 		xpathContext = f.newContext(resource.getContents().get(0));
 		URI childUri = URI.createPlatformPluginURI("/org.eclipse.e4.emf.xpath.test/model/fragment.e4xmi", true);
 		childResource = resourceSet.getResource(childUri, true);
-		xpathChildContext = f.newContext(xpathContext, childResource.getContents().get(0));
+		xpathChildContext = f.newContext(childResource.getContents().get(0));
 	}
 
 	@After

tests/org.eclipse.e4.emf.xpath.test/src/org/eclipse/e4/emf/xpath/test/ExampleQueriesTestCase.java

@@ -25,7 +25,6 @@
 import java.util.Iterator;
 import java.util.List;
 
-import org.eclipse.e4.emf.xpath.EcoreXPathContextFactory;
 import org.eclipse.e4.emf.xpath.XPathContext;
 import org.eclipse.e4.emf.xpath.XPathContextFactory;
 import org.eclipse.e4.emf.xpath.XPathNotFoundException;
@@ -61,7 +60,7 @@ public void setUp() {
 		resourceSet.getPackageRegistry().put(XpathtestPackage.eNS_URI, XpathtestPackage.eINSTANCE);
 		URI uri = URI.createPlatformPluginURI("/org.eclipse.e4.emf.xpath.test/model/Test.xmi", true);
 		resource = resourceSet.getResource(uri, true);
-		xpathContextFactory = EcoreXPathContextFactory.newInstance();
+		xpathContextFactory = XPathContextFactory.newInstance();
 		xpathContext = xpathContextFactory.newContext(resource.getContents().get(0));
 	}
 
@@ -131,7 +130,7 @@ public void testRelative() {
 		EObject context = resource.getContents().get(0);
 		List<EObject> eContents = context.eContents();
 		EObject firstElement = eContents.get(0);
-		XPathContext nestedXpathContext = xpathContextFactory.newContext(xpathContext, firstElement);
+		XPathContext nestedXpathContext = xpathContextFactory.newContext(firstElement);
 
 		List<Node> dotList = nestedXpathContext.stream(".", Node.class).toList();
 		assertEquals(1, dotList.size());