Package net.sourceforge.plantuml.core
Class UmlSource
- java.lang.Object
-
- net.sourceforge.plantuml.core.UmlSource
-
public final class UmlSource extends java.lang.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.
-
-
Constructor Summary
Constructors Constructor Description UmlSource(java.util.List<StringLocated> data, boolean checkEndingBackslash)
UmlSource(java.util.List<StringLocated> data, boolean checkEndingBackslash, java.util.List<StringLocated> rawSource)
Build the source from a text.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
containsIgnoreCase(java.lang.String searched)
DiagramType
getDiagramType()
Retrieve the type of the diagram.java.lang.String
getId()
java.lang.String
getLine(LineLocation n)
java.lang.String
getPlainString()
Return the source as a single String with\n
as line separator.java.lang.String
getRawString()
Display
getTitle()
Retrieve the title, if defined in the diagram source.int
getTotalLineCount()
Return the number of line in the diagram.boolean
getTotalLineCountLessThan5()
boolean
isEmpty()
Check if a source diagram description is empty.boolean
isStartDef()
IteratorCounter2
iterator2()
Allows to iterator over the source.UmlSource
removeInitialSkinparam()
long
seed()
-
-
-
Constructor Detail
-
UmlSource
public UmlSource(java.util.List<StringLocated> data, boolean checkEndingBackslash)
-
UmlSource
public UmlSource(java.util.List<StringLocated> data, boolean checkEndingBackslash, java.util.List<StringLocated> rawSource)
Build the source from a text.- Parameters:
data
- the source of the diagramcheckEndingBackslash
-true
if an ending backslash means that a line has to be collapsed with the following one.
-
-
Method Detail
-
removeInitialSkinparam
public UmlSource removeInitialSkinparam()
-
containsIgnoreCase
public boolean containsIgnoreCase(java.lang.String searched)
-
getDiagramType
public DiagramType getDiagramType()
Retrieve the type of the diagram. This is based on the first line@startfoo
.- Returns:
- the type of the diagram.
-
iterator2
public IteratorCounter2 iterator2()
Allows to iterator over the source.- Returns:
- a iterator that allow counting line number.
-
getPlainString
public java.lang.String getPlainString()
Return the source as a single String with\n
as line separator.- Returns:
- the whole diagram source
-
getRawString
public java.lang.String getRawString()
-
seed
public long seed()
-
getLine
public java.lang.String getLine(LineLocation n)
-
getTotalLineCount
public int getTotalLineCount()
Return the number of line in the diagram.
-
getTotalLineCountLessThan5
public boolean getTotalLineCountLessThan5()
-
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 returnnull
.
-
isStartDef
public boolean isStartDef()
-
getId
public java.lang.String getId()
-
-