Adds support for a jump property on relationship styles.

Author: simonbrowndotje

changelog.md

@@ -12,6 +12,7 @@
 - structurizr-dsl: Relationships to/from software system/container instances can be now defined by using the software system/container identifier.
 - structurizr-dsl: Fixes https://github.com/structurizr/java/issues/435 (Relationship archetype not applied to implicit-source relationships).
 - structurizr-dsl: Adds support for removing relationships between software system instance/container instances, with a view to redefining them via infrastructure nodes.
+- structurizr-dsl: Adds support for a `jump` property on relationship styles.
 
 ## v4.1.0 (28th May 2025)
 

structurizr-core/src/main/java/com/structurizr/view/RelationshipStyle.java

@@ -39,6 +39,10 @@ public final class RelationshipStyle extends AbstractStyle {
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Routing routing;
 
+    /** whether the line should jump over others */
+    @JsonInclude(value = JsonInclude.Include.NON_NULL)
+    private Boolean jump;
+
     /** the position of the annotation along the line; 0 (start) to 100 (end) */
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Integer position;
@@ -142,6 +146,19 @@ public RelationshipStyle routing(Routing routing) {
         return this;
     }
 
+    public Boolean getJump() {
+        return jump;
+    }
+
+    public void setJump(Boolean jump) {
+        this.jump = jump;
+    }
+
+    public RelationshipStyle jump(boolean jump) {
+        setJump(jump);
+        return this;
+    }
+
     public Integer getFontSize() {
         return fontSize;
     }

structurizr-core/src/main/java/com/structurizr/view/RelationshipView.java

@@ -29,6 +29,9 @@ public final class RelationshipView implements PropertyHolder, Comparable<Relati
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Routing routing;
 
+    @JsonInclude(value = JsonInclude.Include.NON_NULL)
+    private Boolean jump;
+
     @JsonInclude(value = JsonInclude.Include.NON_NULL)
     private Integer position;
 
@@ -222,6 +225,24 @@ public void setRouting(Routing routing) {
         this.routing = routing;
     }
 
+    /**
+     * Gets whether this relationship should "jump" when crossing others.
+     *
+     * @return  true if jumping is enabled, false otherwise
+     */
+    public Boolean getJump() {
+        return jump;
+    }
+
+    /**
+     * Sets whether this relationship should "jump" when crossing others.
+     *
+     * @param jump      true if enabled, false otherwise
+     */
+    public void setJump(Boolean jump) {
+        this.jump = jump;
+    }
+
     /**
      * Gets the position of the annotation along the line.
      *
@@ -253,6 +274,7 @@ void copyLayoutInformationFrom(RelationshipView source) {
             setVertices(source.getVertices());
             setPosition(source.getPosition());
             setRouting(source.getRouting());
+            setJump(source.getJump());
         }
     }
 

structurizr-dsl/src/main/java/com/structurizr/dsl/RelationshipStyleParser.java

@@ -234,4 +234,27 @@ void parseRouting(RelationshipStyleDslContext context, Tokens tokens) {
         }
     }
 
+    void parseJump(RelationshipStyleDslContext context, Tokens tokens) {
+        // jump <true|false>
+        RelationshipStyle style = context.getStyle();
+
+        if (tokens.hasMoreThan(FIRST_PROPERTY_INDEX)) {
+            throw new RuntimeException("Too many tokens, expected: jump <true|false>");
+        }
+
+        if (tokens.includes(FIRST_PROPERTY_INDEX)) {
+            String jump = tokens.get(1);
+
+            if ("true".equalsIgnoreCase(jump)) {
+                style.setJump(true);
+            } else if ("false".equalsIgnoreCase(jump)) {
+                style.setJump(false);
+            } else {
+                throw new RuntimeException("Jump must be true or false");
+            }
+        } else {
+            throw new RuntimeException("Expected: jump <true|false>");
+        }
+    }
+
 }

structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslParser.java

@@ -901,6 +901,9 @@ void parse(List<String> lines, File dslFile, boolean fragment, boolean includeIn
                     } else if (RELATIONSHIP_STYLE_ROUTING_TOKEN.equalsIgnoreCase(firstToken) && inContext(RelationshipStyleDslContext.class)) {
                         new RelationshipStyleParser().parseRouting(getContext(RelationshipStyleDslContext.class), tokens);
 
+                    } else if (RELATIONSHIP_STYLE_JUMP_TOKEN.equalsIgnoreCase(firstToken) && inContext(RelationshipStyleDslContext.class)) {
+                        new RelationshipStyleParser().parseJump(getContext(RelationshipStyleDslContext.class), tokens);
+
                     } else if (DEPLOYMENT_ENVIRONMENT_TOKEN.equalsIgnoreCase(firstToken) && inContext(ModelDslContext.class)) {
                         String environment = new DeploymentEnvironmentParser().parse(tokens.withoutContextStartToken());
 

structurizr-dsl/src/main/java/com/structurizr/dsl/StructurizrDslTokens.java

@@ -90,6 +90,7 @@ class StructurizrDslTokens {
     static final String RELATIONSHIP_STYLE_DASHED_TOKEN = "dashed";
     static final String RELATIONSHIP_STYLE_OPACITY_TOKEN = "opacity";
     static final String RELATIONSHIP_STYLE_ROUTING_TOKEN = "routing";
+    static final String RELATIONSHIP_STYLE_JUMP_TOKEN = "jump";
     static final String RELATIONSHIP_STYLE_LINE_STYLE_TOKEN = "style";
     static final String RELATIONSHIP_STYLE_FONT_SIZE_TOKEN = "fontSize";
     static final String RELATIONSHIP_STYLE_WIDTH_TOKEN = "width";

structurizr-dsl/src/test/java/com/structurizr/dsl/RelationshipStyleParserTests.java

@@ -1,6 +1,5 @@
 package com.structurizr.dsl;
 
-import com.structurizr.view.Border;
 import com.structurizr.view.LineStyle;
 import com.structurizr.view.RelationshipStyle;
 import com.structurizr.view.Routing;
@@ -396,4 +395,44 @@ void test_parseRouting_SetsTheRouting() {
         assertEquals(Routing.Curved, relationshipStyle.getRouting());
     }
 
+    @Test
+    void test_parseJump_ThrowsAnException_WhenThereAreTooManyTokens() {
+        try {
+            parser.parseJump(relationshipStyleDslContext(), tokens("jump", "boolean", "extra"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("Too many tokens, expected: jump <true|false>", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseJump_ThrowsAnException_WhenTheValueIsMissing() {
+        try {
+            parser.parseJump(relationshipStyleDslContext(), tokens("jump"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("Expected: jump <true|false>", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseJump_ThrowsAnException_WhenTheValueIsNotValid() {
+        try {
+            parser.parseJump(relationshipStyleDslContext(), tokens("jump", "abc"));
+            fail();
+        } catch (Exception e) {
+            assertEquals("Jump must be true or false", e.getMessage());
+        }
+    }
+
+    @Test
+    void test_parseJump_SetsTheJump() {
+        RelationshipStyleDslContext context = relationshipStyleDslContext();
+        parser.parseJump(context, tokens("jump", "false"));
+        assertEquals(false, relationshipStyle.getJump());
+
+        parser.parseJump(context, tokens("jump", "true"));
+        assertEquals(true, relationshipStyle.getJump());
+    }
+
 }