net.sourceforge.plantuml.core

Class UmlSource

java.lang.Object

net.sourceforge.plantuml.core.UmlSource

public final class UmlSource
extends Object

Represents the textual source of some diagram. The source should start with a @startfoo and end with @endfoo.

So the diagram does not have to be a UML one.

Author:

Arnaud Roques

Constructor Summary

Constructors

Constructor and Description
UmlSource(List<? extends CharSequence> source, boolean checkEndingBackslash) Build the source from a text.

Method Summary

Modifier and Type	Method and Description
DiagramType	getDiagramType() Retrieve the type of the diagram.
String	getLine(int n) Return a specific line of the diagram description.
String	getPlainString() Return the source as a single String with \n as line separator.
Display	getTitle() Retrieve the title, if defined in the diagram source.
int	getTotalLineCount() Return the number of line in the diagram.
boolean	isEmpty() Check if a source diagram description is empty.
IteratorCounter	iterator() Allows to iterator over the source.

Methods inherited from class java.lang.Object

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

Constructor Detail

UmlSource

public UmlSource(List<? extends CharSequence> source,
                 boolean checkEndingBackslash)

Build the source from a text.

Parameters:

source - the source of the diagram

checkEndingBackslash - true if an ending backslash means that a line has to be collapsed with the following one.

Method Detail

getDiagramType

public DiagramType getDiagramType()

Retrieve the type of the diagram. This is based on the first line @startfoo.

Returns:

the type of the diagram.

iterator

public IteratorCounter iterator()

Allows to iterator over the source.

Returns:

a iterator that allow counting line number.

getPlainString

public String getPlainString()

Return the source as a single String with \n as line separator.

Returns:

the whole diagram source

getLine

public String getLine(int n)

Return a specific line of the diagram description.

Parameters:

n - line number, starting at 0

Returns:

getTotalLineCount

public int getTotalLineCount()

Return the number of line in the diagram.

Returns:

isEmpty

public boolean isEmpty()

Check if a source diagram description is empty. Does not take comment line into account.

Returns:

true if the diagram does not contain information.

getTitle

public Display getTitle()

Retrieve the title, if defined in the diagram source. Never return null.

Returns: