net.sourceforge.plantuml.eggs
Class PSystemEgg

java.lang.Object
  net.sourceforge.plantuml.AbstractPSystem
      net.sourceforge.plantuml.eggs.PSystemEgg

All Implemented Interfaces:

Diagram

public class PSystemEgg
extends AbstractPSystem

Method Summary

ImageData	exportDiagram(OutputStream os, int num, FileFormatOption fileFormat) Export the diagram as an image to some format.
String	getDescription()

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

executeCommand, getMetadata, getNbImages, getSource, getTitle, getWarningOrError, isOk, makeDiagramReady, setSource

Methods inherited from class java.lang.Object

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

Method Detail

exportDiagram

public ImageData exportDiagram(OutputStream os,
                               int num,
                               FileFormatOption fileFormat)
                        throws IOException

Description copied from interface: Diagram

Export the diagram as an image to some format. Note that a diagram could be drawn as several images (think about new page for sequence diagram for example).

Parameters:

os - where to write the image

num - useually 0 (index of the image to be exported for this diagram).

fileFormat - file format to use

Returns:

a description of the generated image

Throws:

IOException

getDescription

public String getDescription()