Package de.xam.featdoc.system

Class System

java.lang.Object

de.xam.featdoc.system.System

All Implemented Interfaces:

SystemApi, IWikiFile, IWikiLink, Comparable<System>

public class System
extends Object
implements IWikiLink, Comparable<System>, SystemApi

Systems are compared by sortOrder and label.

Field Summary

Fields

Modifier and Type	Field	Description
final String	wikiName

Constructor Summary

Constructors

Constructor	Description
System(String mermaidDiagramId, String name, String wikiName, int sortOrder)

Method Summary

Modifier and Type	Method	Description
static Comparator<System>	comparator()
int	compareTo(@NotNull System o)
boolean	equals(Object o)
List<Message>	events()
Feature	feature(String name)
List<Feature>	features()
int	hashCode()
boolean	isProducing(Message message)
String	label()
String	localTarget()	local part
Stream<Message>	producedEvents()
Stream<Rule>	rules()
int	sortOrder()
Message	step(Message.Direction direction, Timing timing, String name)
String	toString()
@Nullable String	wikiFolder(I18n i18n)	null for root

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface de.xam.featdoc.wiki.IWikiFile

wikiLink

Methods inherited from interface de.xam.featdoc.system.SystemApi

apiCall, asyncEventIncoming, asyncEventOutgoing, step, uiInput, uiOutput, webHook

Field Details

wikiName

public final String wikiName

Constructor Details

System

public System(String mermaidDiagramId,
 String name,
 String wikiName,
 int sortOrder)

Parameters:

mermaidDiagramId - to be used in generated Mermaid sequence diagrams

name - pretty name with Umlauts and all

wikiName - suitable for a wiki page name / link target

sortOrder - first sort criterion; name is used as second

Method Details

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

sortOrder

public int sortOrder()

step

public Message step(Message.Direction direction,
 Timing timing,
 String name)

Specified by:

step in interface SystemApi

compareTo

public int compareTo(@NotNull
 @NotNull System o)

Specified by:

compareTo in interface Comparable<System>

comparator

public static Comparator<System> comparator()

events

public List<Message> events()

feature

public Feature feature(String name)

features

public List<Feature> features()

isProducing

public boolean isProducing(Message message)

label

public String label()

Specified by:

label in interface IWikiLink

rules

public Stream<Rule> rules()

wikiFolder

@Nullable
public @Nullable String wikiFolder(I18n i18n)

Description copied from interface: IWikiFile

null for root

Specified by:

wikiFolder in interface IWikiFile

toString

public String toString()

Overrides:

toString in class Object

producedEvents

public Stream<Message> producedEvents()

localTarget

public String localTarget()

Description copied from interface: IWikiLink

local part

Specified by:

localTarget in interface IWikiFile

Specified by:

localTarget in interface IWikiLink