This file may be used directly by a script (as shown above) or as a base class
for other sequencers (see UML::Sequence::JavaSeq). It supplies routines for
handling simple outlines like a user could be expected to type by hand. Such
outlines look like this:
At Home.Wash Car
this is an annotation
the next line shows how to specify return values
Garage.retrieve bucket -> bucket
Kitchen.pour soap in bucket
Garage.get sponge -> sponge
the next line specifies an external async event
the next line specifies a conditional, urgent method call
[garageDoorClosed] ! Garage.open door
the next line specifies an iterative method call
* Driveway.apply soapy water
the next line specifies a class/static method call
The class name and method name are separated by a dot. If there are
multiple dots, the method name is everything after the last dot. Classes
and methods in this context are elements of a UML sequence diagram. Classes
get boxes at the top of the page. Method calls are labeled lines from one
class to another. If you want two classes with the same name, you must
append a suffix or prefix (try instanceName:ClassName).
Static (aka class) methods are assumed if there is not dot separator, but
only double colon :: separators, in which case the last text segment
preceded by :: is assumed to be the method name, and is displayed
in italics in the output.
Return values may be specified by the -> marker; everything to the
right of the marker will be used as a label on a dashed line returning from
the called object back to the caller object.
External events can be indicated by the -> marker without any preceding
object/method name. These are rendered as lines originating
from the far right of the image, terminated by a half-arrow, with text to the
right of the marker displayed as the label on a line.
Iterations are denoted by an introductory asterisk *, which is preserved
in the output label. Conditional statements can be added by introducing
an entry with text enclosed by brackets .
For Thread::Apartment applications, urgent methods are introduced
by an exclamation point !, which is preserved in the output text label.
Annotations may be specified using C style comment delimiters,
/* */. Everything between the delimiters will be tagged as annotation on the next
directive line, which the renderer may convert to e.g., tooltips
or text in a margin. NOTE: no escape is provided for closing delimiters
within an annotation.
Finally, in order to properly position return values for nested
method calls, whitespace characters (tabs, spaces) are used to delimit
the scope of nested method calls.