Adds support for custom elements on dynamic views.

Author: simonbrowndotje

build.gradle

@@ -8,7 +8,7 @@ subprojects { proj ->
 
     description = 'Structurizr'
     group = 'com.structurizr'
-    version = '1.14.2'
+    version = '1.15.0'
 
     repositories {
         mavenCentral()

docs/changelog.md

@@ -1,8 +1,9 @@
 # Changelog
 
-## 1.14.2 (unreleased to Maven Central)
+## 1.15.0 (unreleased to Maven Central)
 
 - Adds documentation section filenames into the model.
+- Adds support for custom elements on dynamic views.
 
 ## 1.14.1 (15th August 2022)
 

structurizr-core/src/com/structurizr/view/CustomView.java

@@ -136,6 +136,34 @@ void setAnimations(List<Animation> animations) {
         }
     }
 
+    /**
+     * Adds the given custom element to this view, including relationships to/from that custom element.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void add(@Nonnull CustomElement customElement) {
+        add(customElement, true);
+    }
+
+    /**
+     * Adds the given custom element to this view.
+     *
+     * @param customElement the CustomElement to add
+     * @param addRelationships  whether to add relationships to/from the custom element
+     */
+    public void add(@Nonnull CustomElement customElement, boolean addRelationships) {
+        addElement(customElement, addRelationships);
+    }
+
+    /**
+     * Removes the given custom element from this view.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void remove(@Nonnull CustomElement customElement) {
+        removeElement(customElement);
+    }
+
     /**
      * Adds the default set of elements to this view.
      */

structurizr-core/src/com/structurizr/view/DeploymentView.java

@@ -451,4 +451,32 @@ void setAnimations(List<Animation> animations) {
         }
     }
 
+    /**
+     * Adds the given custom element to this view, including relationships to/from that custom element.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void add(@Nonnull CustomElement customElement) {
+        add(customElement, true);
+    }
+
+    /**
+     * Adds the given custom element to this view.
+     *
+     * @param customElement the CustomElement to add
+     * @param addRelationships  whether to add relationships to/from the custom element
+     */
+    public void add(@Nonnull CustomElement customElement, boolean addRelationships) {
+        addElement(customElement, addRelationships);
+    }
+
+    /**
+     * Removes the given custom element from this view.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void remove(@Nonnull CustomElement customElement) {
+        removeElement(customElement);
+    }
+
 }

structurizr-core/src/com/structurizr/view/DynamicView.java

@@ -100,6 +100,46 @@ public RelationshipView add(@Nonnull StaticStructureElement source, String descr
     }
 
     public RelationshipView add(@Nonnull StaticStructureElement source, String description, String technology, @Nonnull StaticStructureElement destination) {
+        return addRelationshipViaElements(source, description, technology, destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, @Nonnull StaticStructureElement destination) {
+        return add(source, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, String description, @Nonnull StaticStructureElement destination) {
+        return add(source, description, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, String description, String technology, @Nonnull StaticStructureElement destination) {
+        return addRelationshipViaElements(source, description, technology, destination);
+    }
+
+    public RelationshipView add(@Nonnull StaticStructureElement source, @Nonnull CustomElement destination) {
+        return add(source, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull StaticStructureElement source, String description, @Nonnull CustomElement destination) {
+        return add(source, description, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull StaticStructureElement source, String description, String technology, @Nonnull CustomElement destination) {
+        return addRelationshipViaElements(source, description, technology, destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, @Nonnull CustomElement destination) {
+        return add(source, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, String description, @Nonnull CustomElement destination) {
+        return add(source, description, "", destination);
+    }
+
+    public RelationshipView add(@Nonnull CustomElement source, String description, String technology, @Nonnull CustomElement destination) {
+        return addRelationshipViaElements(source, description, technology, destination);
+    }
+
+    private RelationshipView addRelationshipViaElements(@Nonnull Element source, String description, String technology, @Nonnull Element destination) {
         if (source == null) {
             throw new IllegalArgumentException("A source element must be specified.");
         }
@@ -244,6 +284,11 @@ public void endParallelSequence(boolean endAllParallelSequencesAndContinueNumber
 
     @Override
     protected void checkElementCanBeAdded(Element elementToBeAdded) {
+        if (elementToBeAdded instanceof CustomElement) {
+            // all good
+            return;
+        }
+
         if (!(elementToBeAdded instanceof StaticStructureElement)) {
             throw new ElementNotPermittedInViewException("Only people, software systems, containers and components can be added to dynamic views.");
         }

structurizr-core/src/com/structurizr/view/StaticView.java

@@ -1,9 +1,6 @@
 package com.structurizr.view;
 
-import com.structurizr.model.Element;
-import com.structurizr.model.Person;
-import com.structurizr.model.Relationship;
-import com.structurizr.model.SoftwareSystem;
+import com.structurizr.model.*;
 
 import javax.annotation.Nonnull;
 import java.util.ArrayList;
@@ -240,4 +237,32 @@ void setAnimations(List<Animation> animations) {
         }
     }
 
+    /**
+     * Adds the given custom element to this view, including relationships to/from that custom element.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void add(@Nonnull CustomElement customElement) {
+        add(customElement, true);
+    }
+
+    /**
+     * Adds the given custom element to this view.
+     *
+     * @param customElement the CustomElement to add
+     * @param addRelationships  whether to add relationships to/from the custom element
+     */
+    public void add(@Nonnull CustomElement customElement, boolean addRelationships) {
+        addElement(customElement, addRelationships);
+    }
+
+    /**
+     * Removes the given custom element from this view.
+     *
+     * @param customElement the CustomElement to add
+     */
+    public void remove(@Nonnull CustomElement customElement) {
+        removeElement(customElement);
+    }
+
 }

structurizr-core/src/com/structurizr/view/View.java

@@ -510,25 +510,6 @@ final void checkParentAndChildrenHaveNotAlreadyBeenAdded(StaticStructureElement
         }
     }
 
-    /**
-     * Adds the given custom element to this view, including relationships to/from that custom element.
-     *
-     * @param customElement the CustomElement to add
-     */
-    public void add(@Nonnull CustomElement customElement) {
-        add(customElement, true);
-    }
-
-    /**
-     * Adds the given custom element to this view.
-     *
-     * @param customElement the CustomElement to add
-     * @param addRelationships  whether to add relationships to/from the custom element
-     */
-    public void add(@Nonnull CustomElement customElement, boolean addRelationships) {
-        addElement(customElement, addRelationships);
-    }
-
     protected <T extends Element> void addNearestNeighbours(Element element, Class<T> typeOfElement) {
         if (element == null) {
             return;
@@ -562,13 +543,4 @@ protected <T extends Element> void addNearestNeighbours(Element element, Class<T
         }
     }
 
-    /**
-     * Removes the given custom element from this view.
-     *
-     * @param customElement the CustomElement to add
-     */
-    public void remove(@Nonnull CustomElement customElement) {
-        removeElement(customElement);
-    }
-
 }

structurizr-core/test/unit/com/structurizr/view/DynamicViewTests.java

@@ -47,7 +47,7 @@ public void setup() {
     void add_ThrowsAnException_WhenPassedANullSourceElement() {
         try {
             DynamicView dynamicView = workspace.getViews().createDynamicView("key", "Description");
-            dynamicView.add(null, softwareSystemA);
+            dynamicView.add((StaticStructureElement)null, softwareSystemA);
             fail();
         } catch (IllegalArgumentException iae) {
             assertEquals("A source element must be specified.", iae.getMessage());
@@ -58,7 +58,7 @@ void add_ThrowsAnException_WhenPassedANullSourceElement() {
     void add_ThrowsAnException_WhenPassedANullDestinationElement() {
         try {
             DynamicView dynamicView = workspace.getViews().createDynamicView("key", "Description");
-            dynamicView.add(person, null);
+            dynamicView.add(person, (StaticStructureElement)null);
             fail();
         } catch (IllegalArgumentException iae) {
             assertEquals("A destination element must be specified.", iae.getMessage());