de.frag.umlplugin.uml.diagramio
Interface DiagramWriter

All Known Implementing Classes:
CommandSequenceDiagramWriter, GraphmlDiagramWriter, ImageDiagramWriter, SVGDiagramWriter

public interface DiagramWriter

Write diagrams to files.


Method Summary
 boolean canWriteMultipleDiagrams()
          Checks whether this writer can write multiple diagrams or not.
 boolean canWriteThumbnail()
          Checks whether this writer supports storage of image thumbnails.
 void writeDiagram(UMLDiagram[] diagrams, java.lang.String path, boolean saveThumbnail, int thumbnailHeight)
          Writes given diagram to file.
 

Method Detail

canWriteMultipleDiagrams

boolean canWriteMultipleDiagrams()
Checks whether this writer can write multiple diagrams or not.

Returns:
true, if this writer can write multiple diagrams; false, if it can write only one diagram

writeDiagram

void writeDiagram(@NotNull
                  UMLDiagram[] diagrams,
                  @NotNull
                  java.lang.String path,
                  boolean saveThumbnail,
                  int thumbnailHeight)
                  throws java.io.IOException
Writes given diagram to file.

Parameters:
diagrams - array of diagrams to write
path - path to target file
saveThumbnail - true, if thumbnail should be written; false otherwise
thumbnailHeight - desired thumbnail height in pixels
Throws:
java.io.IOException - on IO error

canWriteThumbnail

boolean canWriteThumbnail()
Checks whether this writer supports storage of image thumbnails.

Returns:
true, if this writer can create thumbnail images; false otherwise