Multilingual Wiki Documentation

You are currently using syntax.
In an attempt to improve PlantUML documentation...
Please do not use this website for your own diagrams.
You can click here and use the online server here for your own documentation.

Wiki Toc    Recent changes    View page history    Add new chapter    Reorder page    Raw


Llamando PlantUML desde Java

Puede integrar fácilmente PlantUML con su propio código añadiendo plantuml.jar al classpath.

Calling PlantUML from Java

You can easily integrate PlantUML with your own code by adding plantuml.jar in your classpath.

Generación de un PNG desde un String

Si la descripción del diagrama se encuentra almacenada en un String, se puede emplear la clase SourceStringReader para generar un fichero PNG.

OutputStream png = ...;
String source = "@startuml\n";
source += "Bob -> Alice : hello\n";
source += "@enduml\n";

SourceStringReader reader = new SourceStringReader(source);
// Escribe la primera imagen a "png"
String desc = reader.outputImage(png).getDescription();
// Devuelve una cadena nula si no hay se ha generado nada

PNG generation from a String

If your diagram description is stored in a String, you can use the SourceStringReader class to generate some PNG file.

OutputStream png = ...;
String source = "@startuml\n";
source += "Bob -> Alice : hello\n";
source += "@enduml\n";

SourceStringReader reader = new SourceStringReader(source);
// Write the first image to "png"
String desc = reader.outputImage(png).getDescription();
// Return a null string if no generation

Generación de un PNG desde un File

Si la descripción del diagrama se encuentra almacenada en un File, puede emplearse la clase SourceFileReader para generar un fichero PNG.

File source = ...;
SourceFileReader reader = new SourceFileReader(source);
List<GeneratedImage> list = reader.getGeneratedImages();
// Ficheros generados
File png = list.get(0).getPngFile();

PNG generation from a File

If your diagram description is stored in a File, you can use the SourceFileReader class to generate some PNG file.

File source = ...;
SourceFileReader reader = new SourceFileReader(source);
List<GeneratedImage> list = reader.getGeneratedImages();
// Generated files
File png = list.get(0).getPngFile();

Generación de un SVG desde un String

Si la descripción del diagrama está almacenada en un String, puede utilizar la clase SourceStringReader para generar un fichero SVG.

String source = "@startuml\n";
source += "Bob -> Alice : hello\n";
source += "@enduml\n";

SourceStringReader reader = new SourceStringReader(source);
final ByteArrayOutputStream os = new ByteArrayOutputStream();
// Escribe la primera imagen a "os"
String desc = reader.generateImage(os, new FileFormatOption(FileFormat.SVG));
os.close();

// El XML se guarda en svg
final String svg = new String(os.toByteArray(), Charset.forName("UTF-8"));

SVG generation from a String

If your diagram description is stored in a String, you can use the SourceStringReader class to generate some SVG file.

String source = "@startuml\n";
source += "Bob -> Alice : hello\n";
source += "@enduml\n";

SourceStringReader reader = new SourceStringReader(source);
final ByteArrayOutputStream os = new ByteArrayOutputStream();
// Write the first image to "os"
String desc = reader.generateImage(os, new FileFormatOption(FileFormat.SVG));
os.close();

// The XML is stored into svg
final String svg = new String(os.toByteArray(), Charset.forName("UTF-8"));


Please report any bugs to plantuml@gmail.com or here.
This website is still in beta testing.