Package net.sourceforge.plantuml.core

Interface Diagram

All Superinterfaces:

WarningHandler

All Known Implementing Classes:

AbstractClassOrObjectDiagram, AbstractDiagram, AbstractEntityDiagram, ActivityDiagram, ActivityDiagram3, BoardDiagram, BpmDiagram, ChartDiagram, ChenEerDiagram, ChronologyDiagram, ClassDiagram, CucaDiagram, DescriptionDiagram, DirectOsDiagram, FilesDiagram, FlowDiagram, GanttDiagram, GitDiagram, Help, JsonDiagram, ListSpriteDiagram, MindMapDiagram, NewpagedDiagram, NwDiagram, PacketDiagram, PlainStringsDiagram, PSystemAppleTwo, PSystemCharlie, PSystemColors, PSystemCreole, PSystemDedication, PSystemDefinition, PSystemDitaa, PSystemDonors, PSystemDot, PSystemEbnf, PSystemEgg, PSystemError, PSystemErrorEmpty, PSystemErrorPreprocessor, PSystemErrorV2, PSystemJcckit, PSystemKeycheck, PSystemKeygen, PSystemLatex, PSystemLicense, PSystemListArchimateSprites, PSystemListEmoji, PSystemListFonts, PSystemListOpenIconic, PSystemLost, PSystemMath, PSystemOpenIconic, PSystemPath, PSystemRegex, PSystemRIP, PSystemSalt, PSystemSkinparameterList, PSystemStats, PSystemSudoku, PSystemUnsupported, PSystemVersion, PSystemWelcome, SequenceDiagram, StateDiagram, StdlibDiagram, TimingDiagram, TitledDiagram, UgDiagram, UgSimpleDiagram, WBSDiagram, WireDiagram

public interface Diagram
extends WarningHandler

Method Summary

Modifier and Type	Method	Description
String	checkFinalError()
ImageData	exportDiagram(OutputStream os, int num, FileFormatOption fileFormat)	Export the diagram as an image to some format.
DiagramDescription	getDescription()
InstallationRequirement	getInstallationRequirement()
String	getMetadata()
int	getNbImages()
Set<ParserPass>	getRequiredPass()
UmlSource	getSource()
Display	getTitleDisplay()
String	getWarningOrError()
boolean	hasUrl()

Methods inherited from interface net.sourceforge.plantuml.warning.WarningHandler

addWarning, getWarnings

Method Details

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 - usually 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()

getDescription

DiagramDescription getDescription()

getSource

UmlSource getSource()

getMetadata

String getMetadata()

getWarningOrError

String getWarningOrError()

hasUrl

boolean hasUrl()

getTitleDisplay

Display getTitleDisplay()

getInstallationRequirement

InstallationRequirement getInstallationRequirement()

checkFinalError

String checkFinalError()

getRequiredPass

Set<ParserPass> getRequiredPass()