SequenceDiagramGenerator

com.ossuminc.riddl.diagrams.mermaid.SequenceDiagramGenerator

A mermaid diagram generator for making sequence diagrams

Attributes

Source
SequenceDiagramGenerator.scala
Graph
Supertypes
trait FileBuilder
class Object
trait Matchable
class Any
Known subtypes

Members list

Value members

Concrete methods

def kind: String

Attributes

Source
SequenceDiagramGenerator.scala

Inherited methods

def add(str: String): FileBuilder.this.type

Append a string without indent or suffix

Append a string without indent or suffix

Value parameters

str

The string to append

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(line: String): FileBuilder.this.type

Append an indented line with newline at the end and a level width indent prefix.

Append an indented line with newline at the end and a level width indent prefix. The indent will be done with level * spaces-per-level space characters.

Value parameters

line

The text of the line to be indented

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addIndent(): FileBuilder.this.type

Add just the indent spaces

Add just the indent spaces

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def addLine(line: String): FileBuilder.this.type

Append a line to the buffer with a terminating newline.

Append a line to the buffer with a terminating newline. No prefix is inserted

Value parameters

line

The line to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def append(text: String): FileBuilder.this.type

Append a line to the buffer without newlines or indentation

Append a line to the buffer without newlines or indentation

Value parameters

text

The text to be appended

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
def clear(): Unit

Completely erase the internal buffer

Completely erase the internal buffer

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
def decr: FileBuilder.this.type

Decrement the indent by one level

Decrement the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
final protected def frontMatter(): Unit

Attributes

Inherited from:
MermaidDiagramGenerator
Source
MermaidDiagramGenerator.scala

Attributes

Inherited from:
MermaidDiagramGenerator
Source
MermaidDiagramGenerator.scala
def incr: FileBuilder.this.type

Increment the indent by one level

Increment the indent by one level

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
def nl: FileBuilder.this.type

Append a newline character

Append a newline character

Attributes

Returns

This object for call chaining

Inherited from:
FileBuilder
Source
FileBuilder.scala
protected def spc: String

The number of spaces at the current indent level

The number of spaces at the current indent level

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala

Convert the buffer to a sequence of strings, one line per string

Convert the buffer to a sequence of strings, one line per string

Attributes

Returns
Inherited from:
FileBuilder
Source
FileBuilder.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
FileBuilder -> Any
Inherited from:
FileBuilder
Source
FileBuilder.scala

Inherited and Abstract methods

protected def frontMatterItems: Map[String, String]

Attributes

Inherited from:
MermaidDiagramGenerator
Source
MermaidDiagramGenerator.scala
def title: String

Attributes

Inherited from:
MermaidDiagramGenerator
Source
MermaidDiagramGenerator.scala

Inherited fields

protected val new_line: String

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala
protected val spaces_per_level: Int

Attributes

Inherited from:
FileBuilder
Source
FileBuilder.scala