Package 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.

  • Method Details

    • removeInitialSkinparam

      public UmlSource removeInitialSkinparam()

    • containsIgnoreCase

      public boolean containsIgnoreCase(String searched)

    • create

      public static UmlSource create(List<StringLocated> source, boolean checkEndingBackslash)

    • createWithRaw

      public static UmlSource createWithRaw(List<StringLocated> source, boolean checkEndingBackslash, List<StringLocated> rawSource)
      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.

    • 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

      @Deprecated public String getPlainString()
      Deprecated.
      Use getPlainString(String) instead, like getPlainString("\n")

    • getPlainString

      public String getPlainString(String separator)
      Return the source as a single String.
      Returns:
      the whole diagram source

    • getRawString

      public String getRawString(String separator)

    • seed

      public long seed()

    • getLine

      public 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 return null.

    • isStartDef

      public boolean isStartDef()

    • getId

      public String getId()