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


Appeler PlantUML depuis du Java

Il est facile d'intégrer PlantUML avec votre propre code en rajoutant plantuml.jar dans votre classpath.

Calling PlantUML from Java

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

Génération d'image PNG depuis une chaîne de caractères

Si votre description de diagrammes est stockée dans une String, vous pouvez utiliser la classe SourceStringReader pour générer un fichier PNG.

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

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

Génération d'image PNG depuis un fichier

Si votre description de diagrammes est stockée dans un File, vous pouvez utiliser la classe SourceFileReader pour générer un fichier PNG.

File source = ...;
SourceFileReader reader = new SourceFileReader(source);
List<GeneratedImage> list = reader.getGeneratedImages();
// Generated files
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();

Génération d'image SVG depuis une chaîne de caractères

Si votre description de diagrammes est stockée dans une String, vous pouvez utiliser la classe SourceStringReader pour générer un fichier SVG.

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"));

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.