Package de.xam.featdoc.mermaid.sequence

Record Class SequenceStep

java.lang.Object

java.lang.Record

de.xam.featdoc.mermaid.sequence.SequenceStep

Record Components:

from -

arrow -

lifetimeEvent -

to -

message -

comment - to be rendered in the source code of the diagram as comment

public record SequenceStep(String from, Arrow arrow, SequenceStep.LifetimeEvent lifetimeEvent, String to, String message, String comment)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SequenceStep.LifetimeEvent

Constructor Summary

Constructors

Constructor	Description
SequenceStep(String from, Arrow arrow, SequenceStep.LifetimeEvent lifetimeEvent, String to, String message, String comment)	Creates an instance of a SequenceStep record class.

Method Summary

Modifier and Type	Method	Description
Arrow	arrow()	Returns the value of the arrow record component.
String	comment()	Returns the value of the comment record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	from()	Returns the value of the from record component.
final int	hashCode()	Returns a hash code value for this object.
SequenceStep.LifetimeEvent	lifetimeEvent()	Returns the value of the lifetimeEvent record component.
String	mermaid()
String	message()	Returns the value of the message record component.
String	to()	Returns the value of the to record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

SequenceStep

public SequenceStep(String from,
 Arrow arrow,
 SequenceStep.LifetimeEvent lifetimeEvent,
 String to,
 String message,
 String comment)

Creates an instance of a SequenceStep record class.

Parameters:

from - the value for the from record component

arrow - the value for the arrow record component

lifetimeEvent - the value for the lifetimeEvent record component

to - the value for the to record component

message - the value for the message record component

comment - the value for the comment record component

Method Details

mermaid

public String mermaid()

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

from

public String from()

Returns the value of the from record component.

Returns:

the value of the from record component

arrow

public Arrow arrow()

Returns the value of the arrow record component.

Returns:

the value of the arrow record component

lifetimeEvent

public SequenceStep.LifetimeEvent lifetimeEvent()

Returns the value of the lifetimeEvent record component.

Returns:

the value of the lifetimeEvent record component

to

public String to()

Returns the value of the to record component.

Returns:

the value of the to record component

message

public String message()

Returns the value of the message record component.

Returns:

the value of the message record component

comment

public String comment()

Returns the value of the comment record component.

Returns:

the value of the comment record component