Don't allow duplicate UI Providers for the same class

- Downstream plug-ins should not be able to register and replace the in-built UI Providers because there is no guarantee of the order of registration and no guarantee of expected beahviour if several plug-ins do this.
archimatetool · Sep 13, 2023 · 7f6f5fc · 7f6f5fc
1 parent 4b25ec5
commit 7f6f5fc
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/com.archimatetool.editor/src/com/archimatetool/editor/ui/factory/ObjectUIFactory.java b/com.archimatetool.editor/src/com/archimatetool/editor/ui/factory/ObjectUIFactory.java
@@ -59,7 +59,7 @@ private void registerProviders() {
     }
 
     void registerProvider(IObjectUIProvider provider) {
-        if(provider != null && provider.providerFor() != null) {
+        if(provider != null && provider.providerFor() != null && map.get(provider.providerFor()) == null) {
             map.put(provider.providerFor(), provider);
         }
     }

diff --git a/...ol.editor.tests/src/com/archimatetool/editor/ui/factory/ObjectUIFactoryProviderTests.java b/...ol.editor.tests/src/com/archimatetool/editor/ui/factory/ObjectUIFactoryProviderTests.java
@@ -57,6 +57,22 @@ public void testRegisterProvider() {
         assertNotNull(factory.getProviderForClass(eClass));
         assertEquals(1, factory.map.size());
     }
+
+    @Test
+    public void testNoDuplicateProviders() {
+        IObjectUIProvider provider1 = mock(IObjectUIProvider.class);
+        IObjectUIProvider provider2 = mock(IObjectUIProvider.class);
+
+        EClass eClass = mock(EClass.class);
+        when(provider1.providerFor()).thenReturn(eClass);
+        when(provider2.providerFor()).thenReturn(eClass);
+
+        factory.registerProvider(provider1);
+        assertSame(provider1, factory.getProviderForClass(eClass));
+
+        factory.registerProvider(provider2);
+        assertSame(provider1, factory.getProviderForClass(eClass));
+    }
 
     @Test
     public void testGetProvider_EObject_ArchiMateElement() {