Package com.structurizr.io.plantuml

Class C4PlantUMLWriter

java.lang.Object

com.structurizr.io.plantuml.PlantUMLWriter

com.structurizr.io.plantuml.BasicPlantUMLWriter

com.structurizr.io.plantuml.C4PlantUMLWriter

public class C4PlantUMLWriter
extends BasicPlantUMLWriter

This writer extends the classical one to use the C4-PlantUML sprite library available on GitHub. To make full use of that sprite library, we use Structurizr properties to tweak rendering. It is possible to change relationships directions and rendering using the C4_LAYOUT_DIRECTION and C4_LAYOUT_MODE mode properties.

See Also:

https://github.com/plantuml-stdlib/C4-PlantUML

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	C4PlantUMLWriter.Directions
static class	C4PlantUMLWriter.Layout	Various layout abilities as provided by C4-PlantUML
static class	C4PlantUMLWriter.NoMacroFound
static class	C4PlantUMLWriter.RelationshipModes
static class	C4PlantUMLWriter.Type

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	C4_ELEMENT_TYPE	Defines the C4PlantUMLWriter.Type of component.
static java.lang.String	C4_LAYOUT_DIRECTION	This property indicates to C4-PlantUML library which relationship type to use.
static java.lang.String	C4_LAYOUT_MODE	This property indicates to C4-PlantUML library which relationship mode to use.

Constructor Summary

Constructors

Constructor	Description
C4PlantUMLWriter()
C4PlantUMLWriter(C4PlantUMLWriter.Layout layout, java.lang.String c4PlantUMLBaseUrl)	Constructur providing a base url and a layout
C4PlantUMLWriter(C4PlantUMLWriter.Layout layout, java.util.Collection<java.lang.String> c4PlantUMLIncludes)	Constructor providing the layout and the full list of includes to use

Method Summary

Modifier and Type	Method	Description
static java.util.Collection<java.lang.String>	inferC4PlantUMLLibraryFrom(java.lang.String urlText)
protected void	write(com.structurizr.view.View view, com.structurizr.model.Element element, java.io.Writer writer, int indent)	We replace the write element method to use macros provided by C4-PlantUML
protected void	writeContainerForContainer(com.structurizr.view.ComponentView view, java.io.Writer writer, java.util.function.BiConsumer<com.structurizr.view.ComponentView,java.io.Writer> packageContentWriter)
protected void	writeContainerForSoftwareSystem(com.structurizr.view.ContainerView view, java.io.Writer writer, java.util.function.BiConsumer<com.structurizr.view.ContainerView,java.io.Writer> packageContentWriter)
protected void	writeRelationship(com.structurizr.view.View view, com.structurizr.view.RelationshipView relationshipView, java.io.Writer writer)

Methods inherited from class com.structurizr.io.plantuml.BasicPlantUMLWriter

getDirection, isIncludeNotesForActors, setDirection, setIncludeNotesForActors, write, write, write, write

Methods inherited from class com.structurizr.io.plantuml.PlantUMLWriter

addIncludeFile, addIncludeFile, addIncludeFile, addIncludeURL, addIncludeURL, addIncludeURL, addSkinParam, clearIncludes, clearSkinParams, getIncludes, getSkinParams, isIncludeDiagramMetadata, isUseSequenceDiagrams, setIncludeDiagramMetadata, setUseSequenceDiagrams, toPlantUMLDiagrams, toString, write, write, write, write, writeFooter, writeHeader, writeRelationships

Methods inherited from class java.lang.Object

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

Field Detail

C4_LAYOUT_DIRECTION

public static final java.lang.String C4_LAYOUT_DIRECTION

This property indicates to C4-PlantUML library which relationship type to use. Possible values are given in the C4PlantUMLWriter.Directions enum

See Also:

Constant Field Values

C4_LAYOUT_MODE

public static final java.lang.String C4_LAYOUT_MODE

This property indicates to C4-PlantUML library which relationship mode to use. Possible values are given in the C4PlantUMLWriter.RelationshipModes enum

See Also:

Constant Field Values

C4_ELEMENT_TYPE

public static final java.lang.String C4_ELEMENT_TYPE

Defines the C4PlantUMLWriter.Type of component.

See Also:

Constant Field Values

Constructor Detail

C4PlantUMLWriter

public C4PlantUMLWriter()

C4PlantUMLWriter

public C4PlantUMLWriter(C4PlantUMLWriter.Layout layout,
                        java.lang.String c4PlantUMLBaseUrl)

Constructur providing a base url and a layout

Parameters:

layout - layout to use for each graph

c4PlantUMLBaseUrl - base url of repository. The following GitHub url kinds are supported

• raw content (i.e. "https://raw.githubusercontent.com/plantuml-stdlib/C4-PlantUML/master/")
• Official repository name with branch or tag (i.e. "https://github.com/plantuml-stdlib/C4-PlantUML/tree/master")
• Official repository name without branch. Master is assumed in that case (i.ie "https://github.com/plantuml-stdlib/C4-PlantUML/")

See Also:

inferC4PlantUMLLibraryFrom(java.lang.String)

C4PlantUMLWriter

public C4PlantUMLWriter(C4PlantUMLWriter.Layout layout,
                        java.util.Collection<java.lang.String> c4PlantUMLIncludes)

Constructor providing the layout and the full list of includes to use

Parameters:

layout - layout to use for each graph

c4PlantUMLIncludes - full list of C4PlantUML brushes. It should include C4.puml, C4_Context.puml, C4_Container.puml and C4_Component.puml.

Method Detail

inferC4PlantUMLLibraryFrom

public static java.util.Collection<java.lang.String> inferC4PlantUMLLibraryFrom(java.lang.String urlText)

writeContainerForSoftwareSystem

protected void writeContainerForSoftwareSystem(com.structurizr.view.ContainerView view,
                                               java.io.Writer writer,
                                               java.util.function.BiConsumer<com.structurizr.view.ContainerView,java.io.Writer> packageContentWriter)
                                        throws java.io.IOException

Overrides:

writeContainerForSoftwareSystem in class BasicPlantUMLWriter

Throws:

java.io.IOException

writeContainerForContainer

protected void writeContainerForContainer(com.structurizr.view.ComponentView view,
                                          java.io.Writer writer,
                                          java.util.function.BiConsumer<com.structurizr.view.ComponentView,java.io.Writer> packageContentWriter)
                                   throws java.io.IOException

Overrides:

writeContainerForContainer in class BasicPlantUMLWriter

Throws:

java.io.IOException

write

protected void write(com.structurizr.view.View view,
                     com.structurizr.model.Element element,
                     java.io.Writer writer,
                     int indent)

We replace the write element method to use macros provided by C4-PlantUML

Overrides:

write in class BasicPlantUMLWriter

writeRelationship

protected void writeRelationship(com.structurizr.view.View view,
                                 com.structurizr.view.RelationshipView relationshipView,
                                 java.io.Writer writer)

Overrides:

writeRelationship in class BasicPlantUMLWriter