net.sourceforge.plantuml.core

Interface Diagram

All Known Implementing Classes:

AbstractClassOrObjectDiagram, AbstractEntityDiagram, AbstractPSystem, ActivityDiagram, ActivityDiagram3, ClassDiagram, CompositeDiagram, CucaDiagram, DescriptionDiagram, FlowDiagram, NewpagedDiagram, ObjectDiagram, PostItDiagram, PSystemAppleTwo, PSystemCharlie, PSystemCreole, PSystemCute, PSystemDedication, PSystemDitaa, PSystemDonors, PSystemDot, PSystemEgg, PSystemError, PSystemJcckit, PSystemLicense, PSystemListFonts, PSystemListInternalSprites, PSystemListOpenIconic, PSystemLogo, PSystemLost, PSystemMemorial, PSystemOpenIconic, PSystemOregon, PSystemPath, PSystemProject, PSystemProject2, PSystemRIP, PSystemSalt, PSystemSudoku, PSystemTree, PSystemTuring, PSystemVersion, PSystemXearth, SequenceDiagram, StateDiagram, UmlDiagram

public interface Diagram

Represents a single diagram. A Diagram could be a UML (sequence diagram, class diagram...) or an non-UML diagram.

Author:

Arnaud Roques

Method Summary

Modifier and Type	Method and Description
ImageData	exportDiagram(OutputStream os, int num, FileFormatOption fileFormat) Export the diagram as an image to some format.
DiagramDescription	getDescription()
String	getMetadata()
int	getNbImages() Number of images in this diagram (usually, 1)
UmlSource	getSource() The original source of the diagram
String	getWarningOrError()
boolean	hasUrl() Check if the Diagram have some links.

Method Detail

exportDiagram

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

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

getNbImages

int getNbImages()

Number of images in this diagram (usually, 1)

Returns:

usually 1

getDescription

DiagramDescription getDescription()

getMetadata

String getMetadata()

getWarningOrError

String getWarningOrError()

getSource

UmlSource getSource()

The original source of the diagram

Returns:

hasUrl

boolean hasUrl()

Check if the Diagram have some links.

Returns: