Package org.nuxeo.ecm.core.io.marshallers.puml

Class PlantUMLPrinter

java.lang.Object

org.nuxeo.ecm.core.io.marshallers.puml.PlantUMLPrinter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public class PlantUMLPrinter
extends Object
implements Closeable, Flushable

Since:

2025.12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PlantUMLPrinter.ArrowStyle	The style to apply on an arrow, like dashed, dotted, or changing color.
static enum	PlantUMLPrinter.ElementType
protected static enum	PlantUMLPrinter.Type

Field Summary

Fields

Modifier and Type	Field	Description
protected Deque<PlantUMLPrinter.Type>	typeDeque
protected final PrintWriter	writer

Constructor Summary

Constructors

Constructor	Description
PlantUMLPrinter(Writer writer)

Method Summary

Modifier and Type	Method	Description
void	close()
void	flush()
protected String	formatIdentifier(String identifier)
protected Writer	getWriter()
protected void	indent()
protected void	popType()
protected void	pushTypeIfNeeded(PlantUMLPrinter.Type type)
void	writeArrow(String identifier1, String identifier2)
void	writeArrow(String identifier1, String identifier2, String comment)
void	writeArrow(String identifier1, String identifier2, String comment, PlantUMLPrinter.ArrowStyle style)	since 2025.16
void	writeArrow(String identifier1, String identifier2, PlantUMLPrinter.ArrowStyle style)	since 2025.16
void	writeEndClass()
void	writeEndComponent()
void	writeEndDatabase()
void	writeEndDocument()
void	writeEndPackage()
void	writeEndQueue()
protected void	writeEndSkinparam()
void	writeFreeText(String text)
void	writeHide(String hide)
void	writeSkinparam(String key, String value)
void	writeSkinparam(String parentKey, String key1, String value1)
void	writeSkinparam(String parentKey, String key1, String value1, String key2, String value2)
void	writeSkinparam(String parentKey, String key1, String value1, String key2, String value2, String key3, String value3)
protected void	writeSkinparamKeyValue(String key, String value)
void	writeStartClass(String identifier, String title)
void	writeStartComponent(String identifier)
void	writeStartComponent(String identifier, String title)
void	writeStartComponent(String identifier, String title, String stereo)
void	writeStartDatabase(String identifier, String title)
void	writeStartDocument()
protected void	writeStartElement(PlantUMLPrinter.ElementType type, String identifier, String title, String stereo)
void	writeStartPackage(String identifier, String title)
void	writeStartQueue(String identifier)
void	writeStartQueue(String identifier, String title)
protected void	writeStartSkinparam(String parentKey)
void	writeTextSeparator()
void	writeTitle(String title)

Methods inherited from class java.lang.Object

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

Field Details

writer

protected final PrintWriter writer

typeDeque

protected Deque<PlantUMLPrinter.Type> typeDeque

Constructor Details

PlantUMLPrinter

public PlantUMLPrinter(Writer writer)

Method Details

writeStartDocument

public void writeStartDocument()
                        throws IOException

Throws:

IOException

writeEndDocument

public void writeEndDocument()
                      throws IOException

Throws:

IOException

writeTitle

public void writeTitle(String title)
                throws IOException

Throws:

IOException

writeHide

public void writeHide(String hide)
               throws IOException

Throws:

IOException

Since:

2025.16

writeSkinparam

public void writeSkinparam(String key,
 String value)
                    throws IOException

Throws:

IOException

writeStartSkinparam

protected void writeStartSkinparam(String parentKey)
                            throws IOException

Throws:

IOException

writeSkinparamKeyValue

protected void writeSkinparamKeyValue(String key,
 String value)
                               throws IOException

Throws:

IOException

writeEndSkinparam

protected void writeEndSkinparam()
                          throws IOException

Throws:

IOException

writeSkinparam

public void writeSkinparam(String parentKey,
 String key1,
 String value1)
                    throws IOException

Throws:

IOException

Since:

2025.16

writeSkinparam

public void writeSkinparam(String parentKey,
 String key1,
 String value1,
 String key2,
 String value2)
                    throws IOException

Throws:

IOException

writeSkinparam

public void writeSkinparam(String parentKey,
 String key1,
 String value1,
 String key2,
 String value2,
 String key3,
 String value3)
                    throws IOException

Throws:

IOException

Since:

2025.16

writeStartClass

public void writeStartClass(String identifier,
 String title)
                     throws IOException

Throws:

IOException

Since:

2025.16

writeEndClass

public void writeEndClass()
                   throws IOException

Throws:

IOException

Since:

2025.16

writeStartComponent

public void writeStartComponent(String identifier)
                         throws IOException

Throws:

IOException

writeStartComponent

public void writeStartComponent(String identifier,
 String title)
                         throws IOException

Throws:

IOException

writeStartComponent

public void writeStartComponent(String identifier,
 @Nullable
 String title,
 @Nullable
 String stereo)
                         throws IOException

Throws:

IOException

Since:

2025.16

writeEndComponent

public void writeEndComponent()
                       throws IOException

Throws:

IOException

writeStartDatabase

public void writeStartDatabase(String identifier,
 String title)
                        throws IOException

Throws:

IOException

Since:

2025.16

writeEndDatabase

public void writeEndDatabase()
                      throws IOException

Throws:

IOException

Since:

2025.16

writeStartPackage

public void writeStartPackage(String identifier,
 String title)
                       throws IOException

Throws:

IOException

Since:

2025.16

writeEndPackage

public void writeEndPackage()
                     throws IOException

Throws:

IOException

Since:

2025.16

writeStartQueue

public void writeStartQueue(String identifier)
                     throws IOException

Throws:

IOException

Since:

2025.16

writeStartQueue

public void writeStartQueue(String identifier,
 String title)
                     throws IOException

Throws:

IOException

Since:

2025.16

writeEndQueue

public void writeEndQueue()
                   throws IOException

Throws:

IOException

Since:

2025.16

writeStartElement

protected void writeStartElement(PlantUMLPrinter.ElementType type,
 String identifier,
 @Nullable
 String title,
 @Nullable
 String stereo)
                          throws IOException

Throws:

IOException

writeArrow

public void writeArrow(String identifier1,
 String identifier2)
                throws IOException

Throws:

IOException

writeArrow

public void writeArrow(String identifier1,
 String identifier2,
 @Nullable
 PlantUMLPrinter.ArrowStyle style)
                throws IOException

since 2025.16

Throws:

IOException

writeArrow

public void writeArrow(String identifier1,
 String identifier2,
 @Nullable
 String comment)
                throws IOException

Throws:

IOException

writeArrow

public void writeArrow(String identifier1,
 String identifier2,
 @Nullable
 String comment,
 @Nullable
 PlantUMLPrinter.ArrowStyle style)

since 2025.16

writeFreeText

public void writeFreeText(String text)
                   throws IOException

Throws:

IOException

writeTextSeparator

public void writeTextSeparator()
                        throws IOException

Throws:

IOException

formatIdentifier

protected String formatIdentifier(String identifier)

pushTypeIfNeeded

protected void pushTypeIfNeeded(@Nonnull
 PlantUMLPrinter.Type type)

popType

protected void popType()

indent

protected void indent()

getWriter

protected Writer getWriter()

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException