Package com.structurizr.export.plantuml

Class AbstractPlantUMLExporter

java.lang.Object

com.structurizr.export.AbstractExporter

com.structurizr.export.AbstractDiagramExporter

com.structurizr.export.plantuml.AbstractPlantUMLExporter

All Implemented Interfaces:

DiagramExporter, Exporter

Direct Known Subclasses:

C4PlantUMLExporter, StructurizrPlantUMLExporter

public abstract class AbstractPlantUMLExporter
extends AbstractDiagramExporter

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLANTUML_ANIMATION_PROPERTY
static final String	PLANTUML_INCLUDES_PROPERTY
static final String	PLANTUML_SEQUENCE_DIAGRAM_PROPERTY
static final String	PLANTUML_TITLE_PROPERTY

Fields inherited from class com.structurizr.export.AbstractDiagramExporter

GROUP_SEPARATOR_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractPlantUMLExporter()

Method Summary

Modifier and Type	Method	Description
void	addSkinParam(String name, String value)
protected double	calculateIconScale(String iconUrl)
void	clearSkinParams()
protected Diagram	createDiagram(com.structurizr.view.ModelView view, String definition)
protected boolean	elementStyleHasSupportedIcon(com.structurizr.view.ElementStyle elementStyle)
protected Map<String,String>	getSkinParams()
protected boolean	includeTitle(com.structurizr.view.ModelView view)
protected boolean	isAnimationSupported(com.structurizr.view.ModelView view)
protected void	writeFooter(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeHeader(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeIncludes(com.structurizr.view.ModelView view, IndentingWriter writer)
protected void	writeSkinParams(IndentingWriter writer)

Methods inherited from class com.structurizr.export.AbstractDiagramExporter

createLegend, endContainerBoundary, endDeploymentNodeBoundary, endEnterpriseBoundary, endGroupBoundary, endSoftwareSystemBoundary, export, export, export, export, export, export, export, export, export, export, export, export, getBoundaryContainers, getBoundarySoftwareSystems, getViewOrViewSetProperty, isVisible, isVisible, startContainerBoundary, startDeploymentNodeBoundary, startEnterpriseBoundary, startGroupBoundary, startSoftwareSystemBoundary, writeElement, writeElements, writeRelationship, 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

PLANTUML_TITLE_PROPERTY

public static final String PLANTUML_TITLE_PROPERTY

See Also:

• Constant Field Values

PLANTUML_INCLUDES_PROPERTY

public static final String PLANTUML_INCLUDES_PROPERTY

See Also:

• Constant Field Values

PLANTUML_ANIMATION_PROPERTY

public static final String PLANTUML_ANIMATION_PROPERTY

See Also:

• Constant Field Values

PLANTUML_SEQUENCE_DIAGRAM_PROPERTY

public static final String PLANTUML_SEQUENCE_DIAGRAM_PROPERTY

See Also:

• Constant Field Values

Constructor Details

AbstractPlantUMLExporter

public AbstractPlantUMLExporter()

Method Details

getSkinParams

protected Map<String,String> getSkinParams()

addSkinParam

public void addSkinParam(String name,
 String value)

clearSkinParams

public void clearSkinParams()

includeTitle

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

isAnimationSupported

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

Overrides:

isAnimationSupported in class AbstractDiagramExporter

writeHeader

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

Specified by:

writeHeader in class AbstractDiagramExporter

writeSkinParams

protected void writeSkinParams(IndentingWriter writer)

writeIncludes

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

writeFooter

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

Specified by:

writeFooter in class AbstractDiagramExporter

createDiagram

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

Specified by:

createDiagram in class AbstractDiagramExporter

elementStyleHasSupportedIcon

protected boolean elementStyleHasSupportedIcon(com.structurizr.view.ElementStyle elementStyle)

calculateIconScale

protected double calculateIconScale(String iconUrl)