Package com.structurizr.export.plantuml

Class C4PlantUMLExporter

java.lang.Object

com.structurizr.export.AbstractExporter

com.structurizr.export.AbstractDiagramExporter

com.structurizr.export.plantuml.AbstractPlantUMLExporter

com.structurizr.export.plantuml.C4PlantUMLExporter

All Implemented Interfaces:

DiagramExporter, Exporter

public class C4PlantUMLExporter
extends AbstractPlantUMLExporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	C4PLANTUML_ELEMENT_PROPERTIES_PROPERTY	Set this property to true by calling Configuration.addProperty(String, String) in your ViewSet in order to have all ModelItem.getProperties() for Components being printed in the PlantUML diagrams.
static final String	C4PLANTUML_LEGEND_PROPERTY
static final String	C4PLANTUML_RELATIONSHIP_PROPERTIES_PROPERTY	Set this property to true by calling Configuration.addProperty(String, String) in your ViewSet in order to have all ModelItem.getProperties() for Relationships being printed in the PlantUML diagrams.
static final String	C4PLANTUML_SHADOW
static final String	C4PLANTUML_SPRITE
static final String	C4PLANTUML_STANDARD_LIBRARY_PROPERTY
static final String	C4PLANTUML_STEREOTYPES_PROPERTY
static final String	C4PLANTUML_TAGS_PROPERTY

Fields inherited from class com.structurizr.export.plantuml.AbstractPlantUMLExporter

PLANTUML_ANIMATION_PROPERTY, PLANTUML_INCLUDES_PROPERTY, PLANTUML_SEQUENCE_DIAGRAM_PROPERTY, PLANTUML_TITLE_PROPERTY

Fields inherited from class com.structurizr.export.AbstractDiagramExporter

GROUP_SEPARATOR_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
C4PlantUMLExporter()

Method Summary

Modifier and Type	Method	Description
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.CustomView view)
Diagram	export(com.structurizr.view.DynamicView view, String order)
protected boolean	includeLegend(com.structurizr.view.ModelView view)
protected boolean	includeStereotypes(com.structurizr.view.ModelView view)
protected boolean	includeTags(com.structurizr.view.ModelView view)
protected boolean	isAnimationSupported(com.structurizr.view.ModelView view)
protected boolean	renderAsSequenceDiagram(com.structurizr.view.ModelView 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 boolean	usePlantUMLStandardLibrary(com.structurizr.view.ModelView view)
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.plantuml.AbstractPlantUMLExporter

addSkinParam, calculateIconScale, clearSkinParams, createDiagram, elementStyleHasSupportedIcon, getSkinParams, includeTitle, writeIncludes, writeSkinParams

Methods inherited from class com.structurizr.export.AbstractDiagramExporter

createLegend, export, export, export, export, export, export, export, export, export, export, getBoundaryContainers, getBoundarySoftwareSystems, getViewOrViewSetProperty, 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

Field Details

C4PLANTUML_LEGEND_PROPERTY

public static final String C4PLANTUML_LEGEND_PROPERTY

See Also:

• Constant Field Values

C4PLANTUML_STEREOTYPES_PROPERTY

public static final String C4PLANTUML_STEREOTYPES_PROPERTY

See Also:

• Constant Field Values

C4PLANTUML_TAGS_PROPERTY

public static final String C4PLANTUML_TAGS_PROPERTY

See Also:

• Constant Field Values

C4PLANTUML_STANDARD_LIBRARY_PROPERTY

public static final String C4PLANTUML_STANDARD_LIBRARY_PROPERTY

See Also:

• Constant Field Values

C4PLANTUML_SPRITE

public static final String C4PLANTUML_SPRITE

See Also:

• Constant Field Values

C4PLANTUML_SHADOW

public static final String C4PLANTUML_SHADOW

See Also:

• Constant Field Values

C4PLANTUML_ELEMENT_PROPERTIES_PROPERTY

public static final String C4PLANTUML_ELEMENT_PROPERTIES_PROPERTY

Set this property to true by calling Configuration.addProperty(String, String) in your ViewSet in order to have all ModelItem.getProperties() for Components being printed in the PlantUML diagrams.

The default value is false.

See Also:

• ViewSet.getConfiguration()
• Configuration.getProperties()
• Constant Field Values

C4PLANTUML_RELATIONSHIP_PROPERTIES_PROPERTY

public static final String C4PLANTUML_RELATIONSHIP_PROPERTIES_PROPERTY

Set this property to true by calling Configuration.addProperty(String, String) in your ViewSet in order to have all ModelItem.getProperties() for Relationships being printed in the PlantUML diagrams.

The default value is false.

See Also:

• ViewSet.getConfiguration()
• Configuration.getProperties()
• Constant Field Values

Constructor Details

C4PlantUMLExporter

public C4PlantUMLExporter()

Method Details

writeHeader

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

Overrides:

writeHeader in class AbstractPlantUMLExporter

writeFooter

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

Overrides:

writeFooter in class AbstractPlantUMLExporter

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

export

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

Overrides:

export in class AbstractDiagramExporter

export

public Diagram export(com.structurizr.view.DynamicView view,
 String order)

Overrides:

export 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

isAnimationSupported

protected boolean isAnimationSupported(com.structurizr.view.ModelView view)

Overrides:

isAnimationSupported in class AbstractPlantUMLExporter

includeLegend

protected boolean includeLegend(com.structurizr.view.ModelView view)

includeStereotypes

protected boolean includeStereotypes(com.structurizr.view.ModelView view)

includeTags

protected boolean includeTags(com.structurizr.view.ModelView view)

usePlantUMLStandardLibrary

protected boolean usePlantUMLStandardLibrary(com.structurizr.view.ModelView view)

renderAsSequenceDiagram

protected boolean renderAsSequenceDiagram(com.structurizr.view.ModelView view)