Package com.structurizr.io.plantuml

Class StructurizrPlantUMLWriter

java.lang.Object

com.structurizr.io.plantuml.PlantUMLWriter

com.structurizr.io.plantuml.StructurizrPlantUMLWriter

public class StructurizrPlantUMLWriter
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
StructurizrPlantUMLWriter()	Creates a new PlantUMLWriter, with some default skin params.

Method Summary

Modifier and Type	Method	Description
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	writeHeader(com.structurizr.view.View view, java.io.Writer writer)
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, writeRelationships

Methods inherited from class java.lang.Object

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

Constructor Detail

StructurizrPlantUMLWriter

public StructurizrPlantUMLWriter()

Creates a new PlantUMLWriter, with some default skin params.

Method Detail

write

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

Specified by:

write in class PlantUMLWriter

write

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

Specified by:

write in class PlantUMLWriter

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

writeHeader

protected void writeHeader(com.structurizr.view.View view,
                           java.io.Writer writer)
                    throws java.io.IOException

Overrides:

writeHeader in class PlantUMLWriter

Throws:

java.io.IOException