net.sourceforge.plantuml

Class PSystemError

java.lang.Object

net.sourceforge.plantuml.AbstractPSystem

net.sourceforge.plantuml.PSystemError

All Implemented Interfaces:

Diagram

public class PSystemError
extends AbstractPSystem

Constructor Summary

Constructors

Constructor and Description
PSystemError(UmlSource source, ErrorUml singleError)
PSystemError(UmlSource source, List<ErrorUml> all)

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()
Collection<ErrorUml>	getErrorsUml()
int	getHigherErrorPosition()
List<String>	getSuggest()
String	getWarningOrError()

Methods inherited from class net.sourceforge.plantuml.AbstractPSystem

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

Methods inherited from class java.lang.Object

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

Constructor Detail

PSystemError

public PSystemError(UmlSource source,
                    List<ErrorUml> all)

PSystemError

public PSystemError(UmlSource source,
                    ErrorUml singleError)

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

getSuggest

public List<String> getSuggest()

getDescription

public DiagramDescription getDescription()

getHigherErrorPosition

public final int getHigherErrorPosition()

getErrorsUml

public final Collection<ErrorUml> getErrorsUml()

getWarningOrError

public String getWarningOrError()

Specified by:

getWarningOrError in interface Diagram

Overrides:

getWarningOrError in class AbstractPSystem