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.
-
Method Summary
Modifier and TypeMethodDescriptionboolean
containsIgnoreCase
(java.lang.String searched) static UmlSource
create
(java.util.List<StringLocated> source, boolean checkEndingBackslash) static UmlSource
createWithRaw
(java.util.List<StringLocated> source, boolean checkEndingBackslash, java.util.List<StringLocated> rawSource) Build the source from a text.Retrieve the type of the diagram.java.lang.String
getId()
java.lang.String
java.lang.String
Return the source as a single String with\n
as line separator.java.lang.String
getTitle()
Retrieve the title, if defined in the diagram source.int
Return the number of line in the diagram.boolean
boolean
isEmpty()
Check if a source diagram description is empty.boolean
Allows to iterator over the source.long
seed()
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Method Details
-
removeInitialSkinparam
-
containsIgnoreCase
public boolean containsIgnoreCase(java.lang.String searched) -
create
-
createWithRaw
public static UmlSource createWithRaw(java.util.List<StringLocated> source, boolean checkEndingBackslash, java.util.List<StringLocated> rawSource) Build the source from a text.- Parameters:
source
- the source of the diagramcheckEndingBackslash
-true
if an ending backslash means that a line has to be collapsed with the following one.
-
getDiagramType
Retrieve the type of the diagram. This is based on the first line@startfoo
.- Returns:
- the type of the diagram.
-
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
-
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
Retrieve the title, if defined in the diagram source. Never returnnull
. -
isStartDef
public boolean isStartDef() -
getId
public java.lang.String getId()
-