Package com.structurizr.io.plantuml

Class BasicPlantUMLWriter

java.lang.Object

com.structurizr.io.plantuml.PlantUMLWriter

com.structurizr.io.plantuml.BasicPlantUMLWriter

Direct Known Subclasses:

C4PlantUMLWriter

public class BasicPlantUMLWriter
extends PlantUMLWriter

A writer that outputs diagram definitions that can be used to create diagrams using PlantUML (http://plantuml.com/plantuml/). System landscape, system context, container, component, dynamic and deployment diagrams are supported.

Constructor Summary

Constructors

Constructor	Description
BasicPlantUMLWriter()	Creates a new PlantUMLWriter, with some default skin params.

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDirection()
protected boolean	isIncludeNotesForActors()
void	setDirection(java.lang.String direction)
void	setIncludeNotesForActors(boolean includeNotesForActors)
protected void	write(com.structurizr.view.ComponentView view, java.io.Writer writer)
protected void	write(com.structurizr.view.ContainerView view, java.io.Writer writer)
protected void	write(com.structurizr.view.DynamicView view, java.io.Writer writer)
protected void	write(com.structurizr.view.View view, com.structurizr.model.DeploymentNode deploymentNode, java.io.Writer writer, int indent)
protected void	write(com.structurizr.view.View view, com.structurizr.model.Element element, java.io.Writer writer, int indent)
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.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

Constructor Detail

BasicPlantUMLWriter

public BasicPlantUMLWriter()

Creates a new PlantUMLWriter, with some default skin params.

Method Detail

getDirection

public java.lang.String getDirection()

setDirection

public void setDirection(java.lang.String direction)

isIncludeNotesForActors

protected boolean isIncludeNotesForActors()

setIncludeNotesForActors

public void setIncludeNotesForActors(boolean includeNotesForActors)

write

protected void write(com.structurizr.view.ContainerView view,
                     java.io.Writer writer)

Specified by:

write in class PlantUMLWriter

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

Throws:

java.io.IOException

write

protected void write(com.structurizr.view.ComponentView view,
                     java.io.Writer writer)

Specified by:

write in class PlantUMLWriter

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

Throws:

java.io.IOException

write

protected void write(com.structurizr.view.DynamicView view,
                     java.io.Writer writer)

Specified by:

write in class PlantUMLWriter

write

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

Specified by:

write in class PlantUMLWriter

write

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

Specified by:

write in class PlantUMLWriter

writeRelationship

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

Specified by:

writeRelationship in class PlantUMLWriter