kstatemachine/ru.nsk.kstatemachine.metainfo/UmlMetaInfo

UmlMetaInfo

interface UmlMetaInfo : MetaInfo

Standard MetaInfo, to control export PlantUML and Mermaid feature visualization.

Inheritors

Properties

Link copied to clipboard
abstract val umlLabel: String?

Will be mapped to "long name" for IState, and a "label" for Transition Default: null

Link copied to clipboard
abstract val umlNotes: List<String>

For IState translated to "note right of". For Transition translated to "note on link" (supports only one note). Mermaid does not support this, so it will not take any effect. Default: emptyList()

Link copied to clipboard
abstract val umlStateDescriptions: List<String>

Add description lines for IState Does not have effect for Transition Default: emptyList()

Functions

Link copied to clipboard
inline fun <M : MetaInfo> MetaInfo?.findMetaInfo(): M?

Helper method for getting MetaInfo of specified type