net.sourceforge.plantuml.project

Class PSystemProject

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.project.PSystemProject

All Implemented Interfaces:

Diagram

public class PSystemProject
extends AbstractPSystem

Constructor Summary

Constructors

Constructor and Description
PSystemProject()

Method Summary

Modifier and Type	Method and Description
ImageData	exportDiagram(OutputStream os, int num, FileFormatOption fileFormatOption) Export the diagram as an image to some format.
DiagramDescription	getDescription()
int	getNbImages() Number of images in this diagram (usually, 1)
Project	getProject()

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PSystemProject

public PSystemProject()

Method Detail

getNbImages

public int getNbImages()

Description copied from interface: Diagram

Number of images in this diagram (usually, 1)

Specified by:

getNbImages in interface Diagram

Overrides:

getNbImages in class AbstractPSystem

Returns:

usually 1

getDescription

public DiagramDescription getDescription()

exportDiagram

public ImageData exportDiagram(OutputStream os,
                               int num,
                               FileFormatOption fileFormatOption)
                        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).

fileFormatOption - file format to use

Returns:

a description of the generated image

Throws:

IOException

getProject

public final Project getProject()