Package com.structurizr.export.websequencediagrams

Class WebSequenceDiagramsExporter

java.lang.Object

com.structurizr.export.AbstractExporter

com.structurizr.export.AbstractDiagramExporter

com.structurizr.export.websequencediagrams.WebSequenceDiagramsExporter

All Implemented Interfaces:

DiagramExporter, Exporter

public class WebSequenceDiagramsExporter
extends AbstractDiagramExporter

Exports dynamic diagram definitions that can be copy-pasted into https://www.websequencediagrams.com This implementation only supports a basic sequence of interactions, both synchronous and asynchronous. It doesn't support return messages, parallel behaviour, etc.

Field Summary

Fields inherited from class com.structurizr.export.AbstractDiagramExporter

GROUP_SEPARATOR_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
WebSequenceDiagramsExporter()

Method Summary

Modifier and Type	Method	Description
protected Diagram	createDiagram(com.structurizr.view.ModelView view, String definition)
protected void	endContainerBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endDeploymentNodeBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endEnterpriseBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endGroupBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	endSoftwareSystemBoundary(com.structurizr.view.ModelView view, IndentingWriter writer)
Diagram	export(com.structurizr.view.ComponentView view)
Diagram	export(com.structurizr.view.ContainerView view)
Diagram	export(com.structurizr.view.DeploymentView view)
Diagram	export(com.structurizr.view.DynamicView view)
Diagram	export(com.structurizr.view.SystemContextView view)
Diagram	export(com.structurizr.view.SystemLandscapeView view)
protected void	startContainerBoundary(com.structurizr.view.ModelView view, com.structurizr.model.Container container, IndentingWriter writer)
protected void	startDeploymentNodeBoundary(com.structurizr.view.DeploymentView view, com.structurizr.model.DeploymentNode deploymentNode, IndentingWriter writer)
protected void	startEnterpriseBoundary(com.structurizr.view.ModelView view, String enterpriseName, IndentingWriter writer)
protected void	startGroupBoundary(com.structurizr.view.ModelView view, String group, IndentingWriter writer)
protected void	startSoftwareSystemBoundary(com.structurizr.view.ModelView view, com.structurizr.model.SoftwareSystem softwareSystem, IndentingWriter writer)
protected void	writeElement(com.structurizr.view.ModelView view, com.structurizr.model.Element element, IndentingWriter writer)
protected void	writeFooter(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeHeader(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeRelationship(com.structurizr.view.ModelView view, com.structurizr.view.RelationshipView relationshipView, IndentingWriter writer)

Methods inherited from class com.structurizr.export.AbstractDiagramExporter

createLegend, export, export, export, export, export, export, getBoundaryContainers, getBoundarySoftwareSystems, getViewOrViewSetProperty, isAnimationSupported, isVisible, isVisible, writeElements, writeRelationships

Methods inherited from class com.structurizr.export.AbstractExporter

breakText, findElementStyle, findRelationshipStyle, hasValue, typeOf, typeOf

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

WebSequenceDiagramsExporter

public WebSequenceDiagramsExporter()

Method Details

export

public Diagram export(com.structurizr.view.SystemLandscapeView view)

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.SystemContextView view)

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.ContainerView view)

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.ComponentView view)

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.DynamicView view)

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.DeploymentView view)

Overrides:

export in class AbstractDiagramExporter

writeHeader

protected void writeHeader(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

writeHeader in class AbstractDiagramExporter

writeFooter

protected void writeFooter(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

writeFooter in class AbstractDiagramExporter

startEnterpriseBoundary

protected void startEnterpriseBoundary(com.structurizr.view.ModelView view,
 String enterpriseName,
 IndentingWriter writer)

Specified by:

startEnterpriseBoundary in class AbstractDiagramExporter

endEnterpriseBoundary

protected void endEnterpriseBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endEnterpriseBoundary in class AbstractDiagramExporter

startGroupBoundary

protected void startGroupBoundary(com.structurizr.view.ModelView view,
 String group,
 IndentingWriter writer)

Specified by:

startGroupBoundary in class AbstractDiagramExporter

endGroupBoundary

protected void endGroupBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endGroupBoundary in class AbstractDiagramExporter

startSoftwareSystemBoundary

protected void startSoftwareSystemBoundary(com.structurizr.view.ModelView view,
 com.structurizr.model.SoftwareSystem softwareSystem,
 IndentingWriter writer)

Specified by:

startSoftwareSystemBoundary in class AbstractDiagramExporter

endSoftwareSystemBoundary

protected void endSoftwareSystemBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endSoftwareSystemBoundary in class AbstractDiagramExporter

startContainerBoundary

protected void startContainerBoundary(com.structurizr.view.ModelView view,
 com.structurizr.model.Container container,
 IndentingWriter writer)

Specified by:

startContainerBoundary in class AbstractDiagramExporter

endContainerBoundary

protected void endContainerBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endContainerBoundary in class AbstractDiagramExporter

startDeploymentNodeBoundary

protected void startDeploymentNodeBoundary(com.structurizr.view.DeploymentView view,
 com.structurizr.model.DeploymentNode deploymentNode,
 IndentingWriter writer)

Specified by:

startDeploymentNodeBoundary in class AbstractDiagramExporter

endDeploymentNodeBoundary

protected void endDeploymentNodeBoundary(com.structurizr.view.ModelView view,
 IndentingWriter writer)

Specified by:

endDeploymentNodeBoundary in class AbstractDiagramExporter

writeElement

protected void writeElement(com.structurizr.view.ModelView view,
 com.structurizr.model.Element element,
 IndentingWriter writer)

Specified by:

writeElement in class AbstractDiagramExporter

writeRelationship

protected void writeRelationship(com.structurizr.view.ModelView view,
 com.structurizr.view.RelationshipView relationshipView,
 IndentingWriter writer)

Specified by:

writeRelationship in class AbstractDiagramExporter

createDiagram

protected Diagram createDiagram(com.structurizr.view.ModelView view,
 String definition)

Specified by:

createDiagram in class AbstractDiagramExporter