plantuml language reference guide

7/13/2019 PlantUML Language Reference Guide

1/97

Drawing UML with PlantUML

Language Reference Guide(Version 5737)

PlantUMLis an Open Source project that allows to quickly write:

Sequence diagram,

Usecase diagram,

Class diagram,

Activity diagram,

Component diagram,

State diagram,

Object diagram.

Diagrams are defined using a simple and intuitive language.


2/97

1 SEQUENCE DIAGRAM

1 Sequence Diagram

1.1 Basic examples

Every UML description must start by @startumland must finish by @enduml.

The sequence -> is used to draw a message between two participants.

Participants do not have to be explicitly declared.

To have a dotted arrow, you use -->.

It is also possible to use Alice: Authentication Response

Alice -> Bob: Another authentication RequestAlice > or > Bob: asynchronous call

@enduml

PlantUML : Language Reference Guide, December 11, 2010 (Version 5737) 1 of 96


3/97

1.2 Declaring participant 1 SEQUENCE DIAGRAM

1.2 Declaring participant

It is possible to change participant order using the participantkeyword.

It is also possible to use the actor keyword to use a stickman instead of a box for the participant.

You can rename a participant using the askeyword.

You can also change the background color of actor or participant, using html code or color name.

Everything that starts with simple quote ' is a comment.

@startuml

actor Bob #red

' The only difference between actor and participant is the drawingparticipant Alice

participant "I have a really\nlong name" as L #99FF99

Alice->Bob: Authentication Request

Bob->Alice: Authentication Response

Bob->L: Log transaction

@enduml



4/97

1.3 Use non-letters in participants 1 SEQUENCE DIAGRAM

1.3 Use non-letters in participants

You can use quotes to define participants. And you can use the as keyword to give an alias to thosesparticipants.

@startuml

Alice -> "Bob()" : Hello

"Bob()" -> "This is very\nlong" as Long

' You can also declare:' "Bob()" -> Long as "This is very\nlong"

L on g - -> " Bo b () " : o k

@enduml

1.4 Message to Self

A participant can send a message to itself.

It is also possible to have multilines using \n.

@startuml

Alice->Alice: This is a signal to self.\nIt also demonstrates\nmultiline \ ntext

@enduml



5/97

1.5 Message sequence numbering 1 SEQUENCE DIAGRAM

1.5 Message sequence numbering

The keyword autonumber is used to automatically add number to messages.

@startuml

autonumberBob -> Alice : Authentication Request

Bob Alice : Authentication RequestBob Alice : Another authentication RequestBob Alice : Yet another authentication Request

Bob


6/97

1.5 Message sequence numbering 1 SEQUENCE DIAGRAM

You can specify a format for your number by using between double-quote. The formatting is donewith the Java class DecimalFormat(0 means digit, # means digit and zero if absent).

You can also use some html tags in the format.

@startuml

autonumber "[000]"

Bob -> Alice : Authentication RequestBob Alice : Another authentication RequestBob Alice : Yet another authentication Request

Bob


7/97

1.6 Title 1 SEQUENCE DIAGRAM

1.6 Title

The title keywords is used to put a title.

@startuml

title Simple communication example

Alice -> Bob: Authentication RequestBob --> Alice: Authentication Response

@enduml



8/97

1.7 Splitting diagrams 1 SEQUENCE DIAGRAM

1.7 Splitting diagrams

Thenewpagekeyword is used to split a diagram into several images. You can put a title for the new pagejust after the newpage keyword. This is very handy to print long diagram on several pages.

@startuml

A li ce - > B o b : m es sa ge 1


newpage

A li ce - > B o b : m es sa ge 3A li ce - > B o b : m es sa ge 4

newpage A title for the\nlast page



@enduml



9/97

1.8 Grouping message 1 SEQUENCE DIAGRAM

1.8 Grouping message

It is possible to group messages together using the following keywords:

alt/else

opt

loop

par

break

critical

group, followed by a text to be displayed

It is possible a add a text that will be displayed into the header. The end keyword is used to closethe group. Note that it is possible to nest groups.

@startuml

Alice -> Bob: Authentication Requestalt successful case

Bob -> Alice: Authentication Accepted

else some kind of failure

Bob -> Alice: Authentication Failuregroup My own label

Alice -> Log : Log attack start

loop 1000 timesAlice -> Bob: DNS Attack

end

A li ce - > L o g : L og a tt ac k e nd

endelse Another type of failure

Bob -> Alice: Please repeat

end@enduml



10/97

1.9 Notes on messages 1 SEQUENCE DIAGRAM

1.9 Notes on messages

It is possible to put notes on message using :

note leftor

note rightkeywords just after the message.

You can have multilines note using the end note keyword.

@startumlAlice->Bob : hello

n ot e l ef t : t h is i s a f ir st n ot e

Bob->Alice : oknote right: this is another note

Bob->Bob : I am thinkingnote left

a n ot e

can also be definedon several lines

end note

@enduml



11/97

1.10 Some other notes 1 SEQUENCE DIAGRAM

1.10 Some other notes

It is also possible to place notes relative to participant with:

note left of,

note right ofor

note overkeywords.

It is possible to highlight a note by changing its background color. You can also have multilines noteusing the end note keywords.

@startuml

participant Alice

participant Bobnote left of Alice #aqua

This is displayed

left of Alice.

end note

note right of Alice: This is displayed right of Alice.

note over Alice: This is displayed over Alice.

note over Alice, Bob #FFAAAA: This is displayed\n over Bob and Alice.

note over Bob, Alice

This is yet another

example ofa long note.

end note

@enduml



12/97

1.11 Formatting using HTML 1 SEQUENCE DIAGRAM

1.11 Formatting using HTML

It is also possible to use few html tags like :

, ,

or

or

to change font size

or : the file must be accessible by the filesystem

@startuml

participant Alice

participant "The Famous Bob" as Bob

Alice -> Bob : A well formated messagenote right of Alice

This is displayed

left of Alice.

end notenote left of Bob

This is displayed

left of Alice Bob.end note

note over Alice, Bob

This is hosted by

end note

@enduml



13/97

1.12 Divider 1 SEQUENCE DIAGRAM

1.12 Divider

If you want, you can split a diagram using == separator to divide your diagram into logical steps.

@startuml

== Initialisation ==


== Repetition ==

Alice -> Bob: Another authentication Request

Alice


14/97

1.13 Lifeline Activation and Destruction 1 SEQUENCE DIAGRAM

1.13 Lifeline Activation and Destruction

The activateand deactivate are used to denote participant activation.

Once a participant is activated, its lifeline appears.

The activateand deactivate apply on the previous message.

The destroy denote the end of the lifeline of a participant.

@startuml

participant User

User -> A: DoWork

activate A

A - > B : < < c re at eR eq ue st > >

activate B

B - > C : D oW or kactivate C

C - -> B : W or kD on e

destroy C

B --> A: RequestCreated

deactivate B

A - > U se r : D o ne

deactivate A

@enduml



15/97

1.13 Lifeline Activation and Destruction 1 SEQUENCE DIAGRAM

Nested lifeline can be used, and it is possible to add a color on the lifeline.

@startuml

participant User

User -> A: DoWorkactivate A #FFBBBB

A - > A : I nt er na l c al lactivate A #DarkSalmon


activate B

B --> A: RequestCreated

deactivate Bdeactivate A

A - > U se r : D o ne

deactivate A

@enduml



16/97

1.14 Participant creation 1 SEQUENCE DIAGRAM

1.14 Participant creation

You can use the create keyword just before the first reception of a message to emphasize the fact thatthis message is actually creatingthis new object.

@startuml

B ob - > A l i ce : h el lo

create OtherA li ce - > O th er : n ew

create StringAlice -> String

n ot e r ig ht : Y ou c an a ls o p ut n ot es !

A li ce - -> B ob : o k

@enduml



17/97

1.15 Incoming and outgoing messages 1 SEQUENCE DIAGRAM

1.15 Incoming and outgoing messages

You can use incoming or outgoing arrows if you want to focus on a part of the diagram.

Use square brackets to denotate the left [ or the right ] side of the diagram.

@startuml

[-> A: DoWork

activate A

A - > A : I nt er na l c al l

activate A

A - >] : < < c re at eR eq ue st > >

A


18/97

1.16 Stereotypes and Spots 1 SEQUENCE DIAGRAM

1.16 Stereotypes and Spots

It is possible to add stereotypes to participants using . In the stereotype, you can add aspotted character in a colored circle using the syntax (X,color).

@startuml

participant "Famous Bob" as Bob >

participant Alice > #EEEEEE

Bob->Alice: First message

@enduml

@startuml

participant Bob >

participant Alice >

Bob->Alice: First message

@enduml



19/97

1.17 More information on titles 1 SEQUENCE DIAGRAM

1.17 More information on titles

You can use some HTML tags in the title.

@startuml

title Simple communication example


@enduml

You can add newline using \n in the title description.

@startuml

title Simple communication example\non several lines

Alice -> Bob: Authentication Request

Bob --> Alice: Authentication Response

@enduml



20/97

1.17 More information on titles 1 SEQUENCE DIAGRAM

You can also define title on several lines using title and end titlekeywords.

@startuml

title

Simple communication exampleon several lines and using html

This is hosted by

end title



@enduml



21/97

1.18 Participants englober 1 SEQUENCE DIAGRAM

1.18 Participants englober

It is possible to draw a box arround some participants, using box and end boxcommands.

You can add an optional title or a optional background color, after the box keyword.

@startuml

box " Internal Service" #LightBlue

participant Bobparticipant Alice

end box

participant Other

B ob - > A l i ce : h el lo

Alice -> Other : hello

@enduml



22/97

1.19 Removing Footer 1 SEQUENCE DIAGRAM

1.19 Removing Footer

You can use the hide footboxkeywords to remove the footer of the diagram.

@startuml

hide footbox

title Footer removed



@enduml



23/97

1.20 Skinparam 1 SEQUENCE DIAGRAM

1.20 Skinparam

You can use the skinparam command to change colors and fonts for the drawing. You can use thiscommand :

In the diagram definition, like any other commands,

In an included file,

In a configuration file, provided in the command line or the ANT task.

@startuml

skinparam backgroundColor #EEEBDC

skinparam sequenceArrowColor DeepSkyBlue

skinparam sequenceParticipantBorderColor DeepSkyBlueskinparam sequenceActorBorderColor DeepSkyBlue

skinparam sequenceLifeLineBorderColor blue

skinparam sequenceParticipantBackgroundColor DodgerBlue

skinparam sequenceParticipantFontName Impact

skinparam sequenceParticipantFontSize 17

skinparam sequenceParticipantFontColor #A9DCDF

skinparam sequenceActorBackgroundColor aqua

skinparam sequenceActorFontColor DeepSkyBlueskinparam sequenceActorFontSize 17

skinparam sequenceActorFontName Aapex

skinparam sequenceLifeLineBackgroundColor #A9DCDF

actor User

participant "First Class" as Aparticipant "Second Class" as B

participant "Last Class" as C

User -> A: DoWorkactivate A

A -> B: Create Request

activate BB - > C : D oW or kactivate C


destroy CB --> A: Request Created

deactivate B

A - -> U se r : D o ne

deactivate A@enduml



24/97

1.21 Skin 1 SEQUENCE DIAGRAM

1.21 Skin

Use the keyword skin to change the look of the generated diagram. There are only two skins availabletoday (Rose, which is the default, and BlueModern), but it is possible to write your own skin.

@startuml

skin BlueModern

actor Userparticipant "First Class" as A

participant "Second Class" as B


User -> A: DoWork

activate A


activate B

B - > C : D oW or k

activate C

C - -> B : W or kD on edestroy C

B --> A: Request Created

deactivate B


deactivate A

@enduml



25/97

2 USE CASE DIAGRAM

2 Use Case Diagram

2.1 Usecases

Use cases are enclosed using between parentheses (because two parentheses looks like an oval).

You can also use the usecase keyword to define a usecase.

And you can define an alias, using the askeyword. This alias will be used latter, when defining relations.

@startuml

(First usecase)(Another usecase) as (UC2)

usecase UC3

usecase (Last\nusecase) as UC4

@enduml



26/97

2.2 Actors 2 USE CASE DIAGRAM

2.2 Actors

Actor are enclosed using between two points.

You can also use the actor keyword to define an actor.

And you can define an alias, using the askeyword. This alias will be used latter, when defining relations.

We will see than actor definitions is optional.

@startuml

:First Actor::Another\nactor: as Men2

actor Men3

actor :Last actor: as Men4

@enduml



27/97

2.3 Basic example 2 USE CASE DIAGRAM

2.3 Basic example

To link actors and use cases, the arrow --> is used.

The more dashes - in the arrow, the longer the arrow.

You can add a label on the arrow, by adding a : character in the arrow definition.

In this example, you see that Userhas not been defined before, and is implicitly defined as an actor.

@startuml

User -> (Start)User --> (Use the application) : A small label

:Main Admin: ---> (Use the application) : This is\nyet another\nlabel

@enduml



28/97

2.4 Extension 2 USE CASE DIAGRAM

2.4 Extension

If one actor/use case extends another one, you can use the symbol


29/97

2.5 Using notes 2 USE CASE DIAGRAM

2.5 Using notes

You can use the :

note left of,

note right of,

note top of,

note bottom of

keywords to define notes related to a single object. A note can be also define alone with the note keywords,then linked to other objects using the .. symbol.

@startuml

:Main Admin: as Admin

(Use the application) as (Use)

User -> (Start)

User --> (Use)

Admin ---> (Use)

n ot e r ig ht o f A dm in : T hi s i s a n e xa mp le .

note right of (Use)

A n ot e c an a ls obe on several lines

end note

note "This note is connected\nto several objects." as N2(Start) .. N2

N 2 . . ( U s e)

@enduml



30/97

2.6 Stereotypes 2 USE CASE DIAGRAM

2.6 Stereotypes

You can add stereotypes while defining actors and use cases using .

@startuml

User >:Main Database: as MySql >

( S ta rt ) < < O ne S ho t > >

(Use the application) as (Use) >

User -> (Start)

User --> (Use)

MySql --> (Use)

@enduml



31/97

2.7 Changing arrows direction 2 USE CASE DIAGRAM

2.7 Changing arrows direction

By default, links between classes have two dashes -- and are verticaly oriented. It is possible to usehorizontal link by putting a single dash (or dot) like this:

@startuml

:user: --> (Use case 1)

: u se r : - > ( Us e c as e 2 )

@enduml

You can also change directions by reversing the link:

@startuml

(Use case 1) (dummyLeft)

:user: -right-> (dummyRight):user: -up-> (dummyUp):user: -down-> (dummyDown)

@enduml



32/97

2.8 Title the diagram 2 USE CASE DIAGRAM

You can shorten the arrow by using only the first character of the direction (for example, -d- insteadof-down-) or the two first characters (-do-).

Please note that you should not abuse this functionnality : GraphViz gives usually good resultswithout tweaking.

2.8 Title the diagram

The titlekeywords is used to put a title.

You can use titleand end title keywords for a longer title, as in sequence diagrams.

@startuml

title Simple Usecase\nwith one actor

usecase (Use the application) as (Use)User -> (Use)

@enduml



33/97

2.9 Left to right direction 2 USE CASE DIAGRAM

2.9 Left to right direction

The general default behaviour when building diagram is top to bottom.

@startuml

'defaulttop to bottom direction

user1 --> (Usecase 1)


@enduml

You may change to left to right using the left to right directioncommand. The result is oftenbetter with this direction.

@startuml

left to right direction



@enduml



34/97

2.10 Skinparam 2 USE CASE DIAGRAM

2.10 Skinparam





@startuml

skinparam usecaseBackgroundColor DarkSeaGreen

skinparam usecaseArrowColor Olive

skinparam actorBorderColor blackskinparam usecaseBorderColor DarkSlateGray

skinparam usecaseActorFontName Courier

User >:Main Database: as MySql >

( S ta rt ) < < O ne S ho t > >

(Use the application) as (Use) >

User -> (Start)

User --> (Use)

MySql --> (Use)

@enduml



35/97

3 CLASS DIAGRAM

3 Class Diagram

3.1 Relations between classes

Relations between classes are defined using the following symbols :

Extension Class18

Class19


36/97

3.2 Label on relations 3 CLASS DIAGRAM

3.2 Label on relations

It is possible a add a label on the relation, using :, followed by the text of the label.

For cardinality, you can use double-quotes ""on each side of the relation.

@startuml

Class01 "1" *-- "many" Class02 : contains

Class03 o-- Class04 : agregation

Class05 --> "1" Class06

@enduml



37/97

3.3 Adding methods 3 CLASS DIAGRAM

3.3 Adding methods

To declare fields and methods, you can use the symbol : followed by the fields or methods name.

The system checks for parenthesis to choose between methods and fields.

@startuml

Object


38/97

3.4 Defining visibility 3 CLASS DIAGRAM

3.4 Defining visibility

When you define methods or fields, you can use characters to define the visibility of the correspondingitem:

- private

# protected

package private

+ public

@startumlclass Dummy {

-field1

#field2met hod 1( )

+method2()

}@enduml

You can turn off this feature using the skinparam classAttributeIconSize 0 command :

@startumlskinparam classAttributeIconSize 0

class Dummy {

-field1#field2

met hod 1( )

+method2()}

@enduml



39/97

3.5 Notes and stereotypes 3 CLASS DIAGRAM

3.5 Notes and stereotypes

Stereotypes are defined with the classkeyword, .

You can alse define notes using note left of,note right of,note top of,note bottom ofkeywords.

A note can be also define alone with the note keywords, then linked to other objects using the ..

symbol.

@startuml

class Object >Object


40/97

3.6 More on notes 3 CLASS DIAGRAM

3.6 More on notes

It is also possible to use few html tags like :

, ,

or

or

to change font size

or : the file must be accessible by the filesystem

You can also have a note on several lines.

@startuml

note top of Object

In java, every classextends

this one.

end note

n ot e a s N 1

This note is also

on severalwords lines

And this is hosted by

end note

@enduml



41/97

3.7 Abstract class and interface 3 CLASS DIAGRAM

3.7 Abstract class and interface

You can declare a class as abstract using abstract or abstract class keywords. The class will beprinted in italic.

You can use the interfaceand enum keywords too.

@startuml

abstract class AbstractList

abstract AbstractCollection

interface List

interface Collection

List


42/97

3.8 Using non-letters 3 CLASS DIAGRAM

3.8 Using non-letters

If you want to use non-letters in the class (or enum...) display, you can either :

Use the as keyword in the class definition

Put quotes "" around the class name

@startuml

class "This is my class" as class1

class class2 as "It works this way too"

class2 *-- "foo/dummy" : use

@enduml



43/97

3.9 Hide attributes, methods... 3 CLASS DIAGRAM

3.9 Hide attributes, methods...

You can parameterize the display of classes using the hide/showcommand.

The basic command is: hide empty members. This command will hide attributes or methods if theyare empty.

Instead of empty members, you can use:

empty fieldsor empty attributes for empty fields,

empty methods for empty methods,

fields or attributes which will hide fields, even if they are described,

methodswich will hide methods, even if they are described,

memberswich will hide fields and methods, even if they are described,

circle for the circled character in front of class name,

stereotype for the stereotype.

You can also provide, just after the hideor showkeyword:

classfor all classes,

interface for all interfaces,

enum for all enums,

for classes which are stereotyped with foo1,

an existing class name.

You can use several show/hidecommands to define rules and exceptions.

@startuml

class Dummy1 {

+myMethods()}

class Dummy2 {+hiddenMethod()

}

class Dummy3 {String name

}

hide members

hide circle

show Dummy1 methodshow fields

@enduml



44/97

3.10 Specific Spot 3 CLASS DIAGRAM

3.10 Specific Spot

Usually, a spotted character (C, I, E or A) is used for classes, interface, enum and abstract classes. Butyou can define your own spot for a class when you define the stereotype, adding a single character and acolor, like in this example:

@startuml

class System >

class Date >

@enduml



45/97

3.11 Packages 3 CLASS DIAGRAM

3.11 Packages

You can define a package using the packagekeyword, and optionally declare a background color for yourpackage (Using a html color code or name). When you declare classes, they are automatically put in thelast used package, and you can close the package definition using the end package keyword. You canalso use brackets { }.

Note that package definitions can be nested.@startuml

package "Classic Collections" #DDDDDD {Object


46/97

3.12 Namespaces 3 CLASS DIAGRAM

3.12 Namespaces

In packages, the name of a class is the unique identifier of this class. It means that you cannot have twoclasses with the very same name in different packages. In that case, you should use namespaces insteadof packages.

You can refer to classes from other namespaces by fully qualify them. Classes from the default

namespace are qualified with a starting dot.Note that you dont have to explicitly create namespace : a fully qualified class is automatically putin the right namespace.

@startuml

class BaseClass

namespace net.dummy #DDDDDD

.BaseClass


47/97

3.13 Changing arrows direction 3 CLASS DIAGRAM



@startumlRoom o- Studient

Room *-- Chair

@enduml


@startuml

Studient -o RoomChair --* Room

@enduml

It is also possible to change arrow direction by adding left, right, up or down keywords inside thearrow:

@startuml

foo -left-> dummyLeftfoo -right-> dummyRight

foo -up-> dummyUp

foo -down-> dummyDown@enduml



48/97

3.14 Lollipop interface 3 CLASS DIAGRAM

You can shorten the arrow by using only the first character of the direction (for example, -d- insteadof-down-) or the two first characters (-do-)


3.14 Lollipop interface

You can also define lollipops interface on classes, using the following syntax:

bar ()- foo,

bar ()-- foo,

foo -() bar

@startuml

class foo

bar ()- foo

@enduml


The title keywords is used to put a title. You can use title and end title keywords for a longer title, asin sequence diagrams.

@startuml

title Simple example\nof title

Object


49/97

3.16 Association classes 3 CLASS DIAGRAM

3.16 Association classes

You can define association classafter that a relation has been defined between two classes, like in thisexample:

@startuml

Student : Name

Student "0..*" - "1..*" Course

(Student, Course) .. Enrollment

Enrollment : drop()

Enrollment : cancel()@enduml

You can define it in another direction:

@startuml

Student : NameStudent "0..*" -- "1..*" Course

(Student, Course) . Enrollment

Enrollment : drop()

Enrollment : cancel()@enduml



50/97

3.17 Skinparam 3 CLASS DIAGRAM

3.17 Skinparam





@startuml

skinparam classBackgroundColor PaleGreen

skinparam classArrowColor SeaGreen

skinparam classBorderColor SpringGreenskinparam stereotypeCBackgroundColor YellowGreen

Class01 "1" *-- "many" Class02 : contains

Class03 o-- Class04 : agregation

@enduml



51/97

3.18 Splitting large files 3 CLASS DIAGRAM

3.18 Splitting large files

Sometimes, you will get some very large image files. You can use the page (hpages)x(vpages)command to split the generated image into several files :

hpagesis a number that indicated the number of horizontal pages,

vpagesis a number that indicated the number of vertical pages.

@startuml

' S pl it i nt o 4 p ag es

page 2x2

class BaseClass

namespace net.dummy #DDDDDD.BaseClass


52/97

4 ACTIVITY DIAGRAM

4 Activity Diagram

4.1 Simple Activity

You can use (*)for the starting point and ending point of the activity diagram.

Use --> for arrows.

Example:

@startuml

(*) --> "First Activity""First Activity" --> (*)

@enduml

4.2 Label on arrows

By default, an arrow starts at the last used activity.

You can put a label on a arrow using brackets [ and ] just after the arrow definition.

@startuml

(*) --> "First Activity"

-->[You can put also labels] "Second Activity"--> (*)

@enduml



53/97

4.3 Changing arrow direction 4 ACTIVITY DIAGRAM

4.3 Changing arrow direction

You can use -> for horizontal arrows. It is possible to force arrows direction using the following syntax:

-down->(default arrow)

-right-> or ->

-left->

-up->

@startuml

(*) -up-> "First Activity"

-right-> "Second Activity"--> "Third Activity"

-left-> (*)

@enduml





54/97

4.4 Branches 4 ACTIVITY DIAGRAM

4.4 Branches

You can use if/then/else keywords to define branches.

@startuml

(*) --> " Initialisation"

if "Some Test" then-->[true] "Some Activity"

--> " Another activity"

-right-> (*)else

->[false] "Something else"

-->[Ending process] (*)endif

@enduml



55/97

4.5 More on Branches 4 ACTIVITY DIAGRAM

4.5 More on Branches

By default, a branch is connected to the last defined activity, but it is possible to override this and todefine a link with the ifkeywords.

It is also possible to nest branches.

@startuml

(*) --> if "Some Test" then

-->[true] "activity 1"

i f " " t he n

- > " a c ti vi ty 3 " a s a 3

else

if "Other test" then-left-> "activity 5"

else

--> "activity 6"endif

endif

else

->[false] "activity 2"

endif

a 3 - -> i f " l as t t es t " t he n--> "activity 7"

else

-> "activity 8"endif

@enduml



56/97

4.6 Synchronization 4 ACTIVITY DIAGRAM

4.6 Synchronization

You can use === code === to display synchronization bars.

@startuml

(*) --> ===B1===

--> "Parallel Activity 1"

--> ===B2===

===B1=== --> "Parallel Activity 2"

--> ===B2===

--> (*)

@enduml



57/97

4.7 Long activity description 4 ACTIVITY DIAGRAM

4.7 Long activity description

When you declare activities, you can span on several lines the description text. You can also add \n inthe description. It is also possible to use few html tags like :

or to change font size

or

or

to include an image

You can also give a short code to the activity with the as keyword. This code can be used latter inthe diagram description.

@startuml

(*) -left-> "this activity

is very longand defined on several lines

that contains many text" as A1

-up-> "Another activity\n on several lines"

A1 --> "Short activity "@enduml



58/97

4.8 Notes 4 ACTIVITY DIAGRAM

4.8 Notes

You can add notes on a activity using the commands:

note left,

note right,

note top,

note bottom,

just after the description of the activity you want to note. If you want to put a note on the startingpoint, define the note at the very beginning of the diagram description.

You can also have a note on several lines, using the end note keywords.

@startuml

(*) --> "Some Activity"

note right: This activity has to be defined

"Some Activity" --> (*)note left

T hi s n ot e i s o n

several linesend note

@enduml



59/97

4.9 Partition 4 ACTIVITY DIAGRAM

4.9 Partition

You can define a partition using the partitionkeyword, and optionally declare a background color foryour partition (using a html color code or name).

When you declare activities, they are automatically put in the last used partition.

You can close the partition definition using the end partitionkeyword.@startuml

partition Conductor

(*) --> "Climbs on Platform"- -> = == S 1 = = =

--> Bows

end partition

partition Audience #LightSkyBlue

=== S1 === --> Applauds

partition Conductor

B ow s - -> = == S 2 = = =

--> WavesArmes

Applauds --> === S2 ===end partition

partition Orchestra #CCCCEE

WavesArmes --> Introduction

--> "Play music"

end partition

@enduml



60/97

4.10 Title the diagram 4 ACTIVITY DIAGRAM


Thetitlekeywords is used to put a title. You can use titleand end titlekeywords for a longer title,as in sequence diagrams.

@startuml

title Simple example\nof title

(*) --> "First activity"--> (*)

@enduml



61/97

4.11 Skinparam 4 ACTIVITY DIAGRAM

4.11 Skinparam





@startuml

skinparam backgroundColor #AAFFFF

skinparam activityStartColor red

skinparam activityBarColor SaddleBrownskinparam activityEndColor Silver

skinparam activityBackgroundColor Peru

skinparam activityBorderColor Peru

skinparam activityFontName Impact

(*) --> "Climbs on Platform"

- -> = == S 1 = = =--> Bows

- -> = == S 2 = = =

--> WavesArmes--> (*)

@enduml



62/97

4.12 Complete example 4 ACTIVITY DIAGRAM

4.12 Complete example

@startuml

'https://reader010.{domain}/reader010/html5/0702/5b3a513171e5f/5b3a51633eec1.png

title Servlet Container

(*) --> "ClickServlet.handleRequest()"

--> "new Page"

if "Page.onSecurityCheck" then

->[true] "Page.onInit()"

if "isForward?" then

->[no] "Process controls"

if " continue processing?" then

-->[yes] ===RENDERING===

else

-->[no] ===REDIRECT_CHECK===endif

else-->[yes] ===RENDERING===

endif

if "is Post?" then-->[yes] "Page.onPost()"

--> "Page.onRender()" as render

--> ===REDIRECT_CHECK===else

-->[no] "Page.onGet()"

--> renderendif

else

-->[false] ===REDIRECT_CHECK===endif

if "Do redirect?" then->[yes] "redirect request"

--> ==BEFORE_DESTROY===

elseif "Do Forward?" then

-left->[yes] "Forward request"


else-right->[no] " Render page template"


endifendif

--> "Page.onDestroy()"

-->(*)

@enduml



63/97

4.12 Complete example 4 ACTIVITY DIAGRAM



64/97

5 COMPONENT DIAGRAM

5 Component Diagram

5.1 Components

Components must be bracketed.

You can also use the component keyword to defines a component.

And you can define an alias, using the as keyword.

This alias will be used latter, when defining relations.

@startuml

[First component][Another component] as Comp2

component Comp3

component [Last\ncomponent] as Comp4

@enduml



65/97

5.2 Interfaces 5 COMPONENT DIAGRAM

5.2 Interfaces

Interface can be defined using the () symbol (because this looks like a circle).

You can also use the interface keyword to defines a usecase.

And you can define an alias, using the as keyword.

This alias will be used latter, when defining relations.

We will see latter that interface declaration is optional.

@startuml

() " First Interface"() "Another interface" as Interf2

interface Interf3

interface "Last\ninterface" as Interf4

@enduml



66/97

5.3 Basic example 5 COMPONENT DIAGRAM

5.3 Basic example

Links between elements are made using combinaisons of dotted line .., straight line --, and arrows--> symbols.

@startuml

DataAccess - [First Component]

[First Component] ..> HTTP : use

@enduml



67/97

5.4 Using notes 5 COMPONENT DIAGRAM

5.4 Using notes

You can use the

note left of,

note right of,

note top of,

note bottom of,

keywords to define notes related to a single object.A note can also be defined alone with the notekeywords, then linked to other objects using the ..

symbol.

@startuml

interface "Data Access" as DA

DA - [First Component][First Component] ..> HTTP : use

note left of HTTP : Web Service only

note right of [First Component]

A n ot e c an a ls o

be on several linesend note

@enduml



68/97

5.5 Grouping Components 5 COMPONENT DIAGRAM

5.5 Grouping Components

You can use the package keyword to group components and interfaces together.

@startuml

package "Some Group" {

HTTP - [First Component]

[Another Component]}

package "Other Groups" {FTP - [Second Component]

[First Component] --> FTP

}

@enduml



69/97

5.6 Changing arrows direction 5 COMPONENT DIAGRAM



@startuml

[Component] --> Interface1

[Component] -> Interface2

@enduml


@startuml

Interface1 right

[Component] -up-> up

[Component] -down-> down@enduml



70/97

5.7 Title the diagram 5 COMPONENT DIAGRAM




Thetitlekeywords is used to put a title. You can use titleand end titlekeywords for a longer title,as in sequence diagrams.

@startumltitle Very simple component\ndiagram

interface "Data Access" as DA

DA - [First Component]

[First Component] ..> HTTP : use

@enduml



71/97

5.8 Skinparam 5 COMPONENT DIAGRAM

5.8 Skinparam





@startuml

skinparam componentFontSize 13

skinparam interfaceBackgroundColor RosyBrown

skinparam interfaceBorderColor blackskinparam componentBackgroundColor gold

skinparam componentBorderColor orange

skinparam componentArrowColor #FF6655

skinparam componentArrowFontColor #777777skinparam componentFontName Courier

skinparam componentArrowFontName Impact

() "Data Access" as DA

DA - [First Component]

[First Component] ..> () HTTP : use

@enduml



72/97

6 STATE DIAGRAM

6 State Diagram

6.1 Simple State

You can use [*]for the starting point and ending point of the state diagram.

Use --> for arrows.

@startuml

[*] --> State1

State1 --> [*]S ta te 1 : t hi s i s a s tr in g

State1 : this is another string

State1 -> State2

State2 --> [*]

@enduml



73/97

6.2 Composite state 6 STATE DIAGRAM

6.2 Composite state

A state can also be composite. You have to define it using the state keywords and brackets.

@startuml

[*] --> NotShooting

state NotShooting {[*] --> Idle

Idle --> Configuring : EvConfig

Configuring --> Idle : EvConfig}

state Configuring {

[*] --> NewValueSelectionNewValueSelection --> NewValuePreview : EvNewValue

NewValuePreview --> NewValueSelection : EvNewValueRejected

NewValuePreview --> NewValueSelection : EvNewValueSaved

state NewValuePreview {

State1 -> State2

}

}

@enduml



74/97

6.3 Long name 6 STATE DIAGRAM

6.3 Long name

You can also use the state keyword to use long description for states.

@startuml

[*] -> State1

State1 --> State2 : Succeeded

State1 --> [*] : AbortedState2 --> State3 : Succeeded

State2 --> [*] : Aborted

state State3 {state "Accumulate Enough Data\nLong State Name" as long1

l on g1 : J us t a t es t

[*] --> long1

long1 --> long1 : New Datalong1 --> ProcessData : Enough Data

}

State3 --> State3 : FailedState3 --> [*] : Succeeded / Save Result

State3 --> [*] : Aborted

@enduml



75/97

6.4 Concurrent state 6 STATE DIAGRAM

6.4 Concurrent state

You can define concurrent state into a composite state using the -- symbol as separator.

@startuml

[*] --> Active

state Active {[*] -> NumLockOff

NumLockOff --> NumLockOn : EvNumLockPressed

NumLockOn --> NumLockOff : EvNumLockPressed--

[*] -> CapsLockOff

CapsLockOff --> CapsLockOn : EvCapsLockPressed

CapsLockOn --> CapsLockOff : EvCapsLockPressed--

[*] -> ScrollLockOff

ScrollLockOff --> ScrollLockOn : EvCapsLockPressedScrollLockOn --> ScrollLockOff : EvCapsLockPressed

}

@enduml



76/97

6.5 Arrow direction 6 STATE DIAGRAM

6.5 Arrow direction

You can use -> for horizontal arrows. It is possible to force arrows direction using the following syntax:

-down->(default arrow)

-right-> or ->

-left->

-up->

@startuml

[*] -up-> FirstFirst -right-> Second

Second --> Third

Third -left-> Last

@enduml

You can shorten the arrow by using only the first character of the direction (for example, -d- instead

of-down-) or the two first characters (-do-).Please note that you should not abuse this functionnality : GraphViz gives usually good resultswithout tweaking.



77/97

6.6 Note 6 STATE DIAGRAM

6.6 Note

You can alse define notes using:

note left of,

note right of,

note top of,

note bottom of

keywords. You can also define notes on several lines.

@startuml

[*] --> Active

Active --> Inactive

note left of Active : this is a short\nnote

note right of InactiveA n ot e c an a ls o

be defined onseveral lines

end note

@enduml



78/97

6.7 More in notes 6 STATE DIAGRAM

6.7 More in notes

You can put notes on composite states.

@startuml

[*] --> NotShooting

state "Not Shooting State" as NotShooting {state "Idle mode" as Idle

state "Configuring mode" as Configuring

[*] --> IdleIdle --> Configuring : EvConfig

Configuring --> Idle : EvConfig

}

n ot e r ig ht o f N ot Sh oo ti ng : T hi s i s a n ot e o n a c om po si te s ta te

@enduml



79/97

7 OBJECTS DIAGRAM

7 Objects Diagram

7.1 Definition of objects

You define instance of objects using the object keywords.

@startuml

object firstObjectobject "My Second Object" as o2

@enduml

7.2 Relations between objects

Relations between objects are defined using the following symbols :

Extension


80/97

7.3 Adding fields 7 OBJECTS DIAGRAM

7.3 Adding fields

To declare fields, you can use the symbol : followed by the fields name.

@startuml

object user

u se r : n am e = " D um my "u se r : i d = 1 23

@enduml

It is also possible to ground between brackets {} all fields.

@startumlobject user {

name = "Dummy"id = 1 23

}

@enduml



81/97

8 COMMON COMMANDS

8 Common commands

8.1 Footer and header

You can use the commands headeror footer to add a footer or a header on any generated diagram.

You can optionally specify if you want a center, left or right footer/header, by adding a keywork.

As for title, it is possible to define a header or a footer on several lines.

It is also possible to put some HTML into the header or footer

@startuml


header

Warning: This is a demonstration diagram.

Do not use in production.endheader

center footer Generated for demonstration@enduml



82/97

8.2 Zoom 8 COMMON COMMANDS

8.2 Zoom

You can use the scale command to zoom the generated image. You can use either a number or a fractionto define the scale factor. You can also specify either width or height (in pixel). And you can also giveboth width and height : the image is scaled to fit inside the specified dimension.

scale 1.5,

scale 2/3,

scale 200 width,

scale 200 height,

scale 200*100

@startuml

scale 180*90

Bob->Alice : hello@enduml



83/97

8.3 Rotation 8 COMMON COMMANDS

8.3 Rotation

Sometimes, and especially for printing, you may want to rotate the generated image, so that it fits betterin the page. You can use the rotate command for this.

@startuml

rotate

title Simple Usecase\nwith one actor"Use the application" as (Use)

User -> (Use)

@enduml



84/97

9 CHANGING FONTS AND COLORS

9 Changing fonts and colors

9.1 Usage

You can change colors and font of the drawing using the skinparam command. Example:

skinparam backgroundColor yellow

You can use this command :


In an included file (see Preprocessing),




85/97

9.2 Color 9 CHANGING FONTS AND COLORS

9.2 Color

You can use either standard color name or RGB code.

Parameter name Default Color CommentValue

backgroundColor white Background of the page

activityArrowColor #A80036 Color of arrows in activity diagrams

activityBackgroundColor #FEFECE Background of activities

activityBorderColor #A80036 Color of activity borders

activityStartColor black Starting circle in activity diagrams

activityEndColor black Ending circle in activity diagrams

activityBarColor black Synchronization bar in activity diagrams

usecaseArrowColor #A80036 Color of arrows in usecase diagrams

actorBackgroundColor #FEFECE Heads color of actor in usecase diagrams

actorBorderColor #A80036 Color of actor borders in usecase diagrams

usecaseBackgroundColor #FEFECE Background of usecases

usecaseBorderColor #A80036 Color of usecase borders in usecase diagrams

classArrowColor #A80036 Color of arrows in class diagrams

classBackgroundColor #FEFECE Background of classes/interface/enum in class diagrams

classBorderColor #A80036 Borders of classes/interface/enum in class diagrams

packageBackgroundColor #FEFECE Background of packages in class diagrams

packageBorderColor #A80036 Borders of packages in class diagrams

stereotypeCBackgroundColor #ADD1B2 Background of class spots in class diagrams

stereotypeABackgroundColor #A9DCDF Background of abstract class spots in class diagrams

stereotypeIBackgroundColor #B4A7E5 Background of interface spots in class diagrams

stereotypeEBackgroundColor #EB937F Background of enum spots in class diagrams

componentArrowColor #A80036 Color of arrows in component diagrams

componentBackgroundColor #FEFECE Background of comp onentscomponentBorderColor #A80036 Borders of components

interfaceBackgroundColor #FEFECE Background of interface in component diagrams

interfaceBorderColor #A80036 Border of interface in component diagrams

noteBackgroundColor #FBFB77 Background of notes

noteBorderColor #A80036 Border of notes

stateBackgroundColor #FEFECE Background of states in state diagrams

stateBorderColor #A80036 Border of states in state diagrams

stateArrowColor #A80036 Colors of arrows in state diagrams

sequenceArrowColor #A80036 Color of arrows in sequence diagrams

sequenceActorBackgroundColor #FEFECE Heads color of actor in sequence diagrams

sequenceActorBorderColor #A80036 Border of actor in sequence diagrams

sequenceGroupBackgroundColor #EEEEEE Header color of alt/opt/loop in sequence diagramssequenceLifeLineBackgroundColor white Background of life line in sequence diagrams

sequenceLifeLineBorderColor #A80036 Border of life line in sequence diagrams

sequenceParticipantBackgroundColor #FEFECE Background of participant in sequence diagrams

sequenceParticipantBorderColor #A80036 Border of participant in sequence diagrams



86/97

9.3 Font color, name and size 9 CHANGING FONTS AND COLORS

9.3 Font color, name and size

You can change the font for the drawing usingxxxFontColor,xxxFontSizeandxxxFontNameparameters.Example:

skinparam classFontColor red

skinparam classFontSize 10

skinparam classFontName Aapex

You can also change the default font for all fonts using skinparam defaultFontName.Example:

skinparam defaultFontName Aapex

Please note the fontname is highly system dependant, so do not over use it, if you look for portability.

Parameter Default Comment

Name Value

activityFontColor black

Used for activity boxactivityFontSize 14activityFontStyle plain

activityFontNameactivityArrowFontColor black

Used for text on arrows in activity diagramsactivityArrowFontSize 13activityArrowFontStyle plainactivityArrowFontName

circledCharacterFontColor black

Used for text in circle for class, enum and otherscircledCharacterFontSize 17circledCharacterFontStyle boldcircledCharacterFontName CouriercircledCharacterRadius 11classArrowFontColor black

Used for text on arrows in class diagramsclassArrowFontSize 10

classArrowFontStyle plainclassArrowFontName

classAttributeFontColor black

Class attributes and methodsclassAttributeFontSize 10classAttributeIconSize 10classAttributeFontStyle plainclassAttributeFontName

classFontColor black

Used for classes nameclassFontSize 12classFontStyle plainclassFontName

classStereotypeFontColor black

Used for stereotype in classesclassStereotypeFontSize 12classStereotypeFontStyle italicclassStereotypeFontName

componentFontColor black

Used for components namecomponentFontSize 14componentFontStyle plaincomponentFontName

componentStereotypeFontColor black

Used for stereotype in componentscomponentStereotypeFontSize 14componentStereotypeFontStyle italiccomponentStereotypeFontName

componentArrowFontColor black

Used for text on arrows in component diagrams

componentArrowFontSize 13

componentArrowFontStyle plaincomponentArrowFontName



87/97


noteFontColor black

Used for notes in all diagrams but sequence diagramsnoteFontSize 13noteFontStyle plainnoteFontName

packageFontColor black

Used for package and partition namespackageFontSize 14packageFontStyle plainpackageFontName

sequenceActorFontColor black

Used for actor in sequence diagramssequenceActorFontSize 13sequenceActorFontStyle plainsequenceActorFontName

sequenceDividerFontColor black

Used for text on dividers in sequence diagramssequenceDividerFontSize 13sequenceDividerFontStyle boldsequenceDividerFontName

sequenceArrowFontColor black

Used for text on arrows in sequence diagramssequenceArrowFontSize 13sequenceArrowFontStyle plainsequenceArrowFontName

sequenceGroupingFontColor black

Used for text for else in sequence diagramssequenceGroupingFontSize 11sequenceGroupingFontStyle plainsequenceGroupingFontName

sequenceGroupingHeaderFontColor black

Used for text for alt/opt/loop headers in sequence diagramssequenceGroupingHeaderFontSize 13sequenceGroupingHeaderFontStyle plainsequenceGroupingHeaderFontName

sequenceParticipantFontColor black

Used for text on participant in sequence diagrams

sequenceParticipantFontSize 13

sequenceParticipantFontStyle plainsequenceParticipantFontName

sequenceTitleFontColor black

Used for titles in sequence diagramssequenceTitleFontSize 13sequenceTitleFontStyle plainsequenceTitleFontName

titleFontColor black

Used for titles in all diagrams but sequence diagramstitleFontSize 18titleFontStyle plaintitleFontName

stateFontColor black

Used for states in state diagramsstateFontSize 14

stateFontStyle plainstateFontName

stateArrowFontColor black

Used for text on arrows in state diagramsstateArrowFontSize 13stateArrowFontStyle plainstateArrowFontName

stateAttributeFontColor black

Used for states description in state diagramsstateAttributeFontSize 12stateAttributeFontStyle plainstateAttributeFontName

usecaseFontColor black

Used for usecase labels in usecase diagramsusecaseFontSize 14usecaseFontStyle plainusecaseFontName



88/97


usecaseStereotypeFontColor black

Used for stereotype in usecaseusecaseStereotypeFontSize 14usecaseStereotypeFontStyle italicusecaseStereotypeFontName

usecaseActorFontColor black

Used for actor labels in usecase diagramsusecaseActorFontSize 14usecaseActorFontStyle plainusecaseActorFontName

usecaseActorStereotypeFontColor black

Used for stereotype for actorusecaseActorStereotypeFontSize 14usecaseActorStereotypeFontStyle italicusecaseActorStereotypeFontName

usecaseArrowFontColor black

Used for text on arrows in usecase diagramsusecaseArrowFontSize 13usecaseArrowFontStyle plainusecaseArrowFontName

footerFontColor black

Used for footerfooterFontSize 10footerFontStyle plainfooterFontName

headerFontColor black

Used for headerheaderFontSize 10headerFontStyle plainheaderFontName



89/97

9.4 Black and White 9 CHANGING FONTS AND COLORS

9.4 Black and White

You can force the use of a blackwhite output using the skinparam monochrome truecommand.

@startuml

skinparam monochrome true

actor User

participant "First Class" as Aparticipant "Second Class" as B


User -> A: DoWork

activate A

A -> B: Create Requestactivate B

B - > C : D oW or kactivate C


destroy C

B --> A: Request Created

deactivate B


deactivate A

@enduml



90/97

10 PREPROCESSING

10 Preprocessing

Some minor preprocessing capabilities are included in PlantUML, and available for all diagrams.Thoses functionnalities are very similar to the C language preprocessor, except that the special char-

acter # has been changed to the exclamation mark !.

10.1 Including files

Use the !includedirective to include file in your diagram.Imagine you have the very same class that appears in many diagrams. Instead of duplicating the

description of this class, you can define a file that contains the description.

@startuml

!include List.iumlList


91/97

10.2 Constant definition 10 PREPROCESSING

10.2 Constant definition

You can define constant using the !define directive. As in C language, a constant name can only usealphanumeric and underscore characters, and cannot start with a digit.

@startuml

!define SEQUENCE (S,#AAAAAA) Database Sequence

!define TABLE (T,#FFAAAA) Database Table

class USER >class ACCOUNT >

class UID >

USER "1" -- "*" ACCOUNT

USER -> UID

@enduml

Of course, you can use the !include directive to define all your constants in a single file that youinclude in your diagram.

Constant can be undefined with the !undef XXX directive.



92/97

10.3 Conditions 10 PREPROCESSING

10.3 Conditions

You can use !ifdef XXXand !endifdirectives to have conditionnal drawings.The lines between those two directives will be included only if the constant after the !ifdefdirective

has been defined before.You can also provide a !elsepart which will be included if the constant has not been defined.

@startuml!include ArrayList.iuml

@enduml

File ArrayList.iuml:

class ArrayList

!ifdef SHOW_METHODS

ArrayList : int size()ArrayList : void clear()

!endif

You can then use the !define directive to activate the conditionnal part of the diagram.

@startuml

!define SHOW_METHODS!include ArrayList.iuml

@enduml

You can also use the !ifndef directive that includes lines if the provided constant has NOT beendefined.



93/97

11 INTERNATIONALIZATION

11 Internationalization

The PlantUML language use lettersto define actor, usecase and so on. But lettersare not only A-Z latincharacters, it could be any kind of letter from any language.

@startumlskinparam backgroundColor #EEEBDCactor participant "" as Aparticipant "" as Bparticipant "" as

-> A: activate AA -> B: activate BB -> : activate --> B: destroy B --> A: deactivate BA --> : deactivate A@enduml

11.1 Charset

The default charset used when reading the text files containing the UML text description is systemdependant. Normally, it should just be fine, but in some case, you may want to the use another charset.For example, with the command line:

java -jar plantuml.jar -charset UTF-8 files.txt

Or, with the ant task:



94/97

11.2 Font Issues 11 INTERNATIONALIZATION

Depending of your Java installation, the following charset should be available: ISO-8859-1, UTF-8,UTF-16BE, UTF-16LE, UTF-16.

11.2 Font IssuesWhen using East Asian Fonts, you may have some issues, becauseGraphvizdefault fonts may not containssome characters. So you may have to force the usage of a system font that contains those characters, byadding the following lines in your diagram descriptions:

skinparam defaultFontName MS Mincho



95/97

12 COLOR NAMES

12 Color Names

Here is the list of colors recognized by PlantUML. Note that color names are case insensitive.

AliceBlue GhostWhite NavajoWhiteAntiqueWhite GoldenRod NavyAquamarine Gold OldLaceAqua Gray OliveDrabAzure GreenYellow OliveBeige Green OrangeRedBisque HoneyDew OrangeBlack HotPink OrchidBlanchedAlmond IndianRed PaleGoldenRodBlueViolet Indigo PaleGreen

Blue Ivory PaleTurquoiseBrown Khaki PaleVioletRedBurlyWood LavenderBlush PapayaWhipCadetBlue Lavender PeachPuff Chartreuse LawnGreen PeruChocolate LemonChiffon PinkCoral LightBlue PlumCornflowerBlue LightCoral PowderBlueCornsilk LightCyan PurpleCrimson LightGoldenRodYellow RedCyan LightGreen RosyBrownDarkBlue LightGrey RoyalBlue

DarkCyan LightPink SaddleBrownDarkGoldenRod LightSalmon SalmonDarkGray LightSeaGreen SandyBrownDarkGreen LightSkyBlue SeaGreenDarkKhaki LightSlateGray SeaShellDarkMagenta LightSteelBlue SiennaDarkOliveGreen LightYellow SilverDarkOrchid LimeGreen SkyBlueDarkRed Lime SlateBlueDarkSalmon Linen SlateGrayDarkSeaGreen Magenta SnowDarkSlateBlue Maroon SpringGreen

DarkSlateGray MediumAquaMarine SteelBlueDarkTurquoise MediumBlue TanDarkViolet MediumOrchid TealDarkorange MediumPurple ThistleDeepPink MediumSeaGreen TomatoDeepSkyBlue MediumSlateBlue TurquoiseDimGray MediumSpringGreen VioletDodgerBlue MediumTurquoise WheatFireBrick MediumVioletRed WhiteSmokeFloralWhite MidnightBlue WhiteForestGreen MintCream YellowGreenFuchsia MistyRose Yellow

Gainsboro Moccasin



96/97

CONTENTS CONTENTS

Contents

1 Sequence Diagram 1

1.1 Basic examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.2 Declaring participant . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21.3 Use non-letters in participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.4 Message to Self . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.5 Message sequence numbering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.6 Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.7 Splitting diagrams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71.8 Grouping message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81.9 Notes on messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91.10 S ome other notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.11 Formatting using HTML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111.12 Divider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121.13 Lifeline Activation and Destruction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131.14 Participant creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.15 Incoming and outgoing messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161.16 S tereotypes and Spots . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 171.17 More information on titles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181.18 P articipants englob er . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.19 R emoving Footer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211.20 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.21 Skin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

2 Use Case Diagram 24

2.1 Usecases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242.2 Actors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252.3 Basic example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262.4 Extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272.5 Using notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

2.6 Stereotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292.7 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 302.8 Title the diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 312.9 Left to right direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 322.10 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

3 Class Diagram 34

3.1 Relations between classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343.2 Label on relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 353.3 Adding methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363.4 Defining visibility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 373.5 Notes and stereotypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 383.6 More on notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

3.7 Abstract class and interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403.8 Using non-letters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 413.9 Hide attributes, methods... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423.10 Specific Spot . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 433.11 Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443.12 Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453.13 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 463.14 L ollipop interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473.15 T itle the diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 473.16 A ssociation classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 483.17 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 493.18 S plitting large files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50



97/97

CONTENTS CONTENTS

4 Activity Diagram 51

4.1 Simple Activity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514.2 Label on arrows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 514.3 Changing arrow direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 524.4 Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 534.5 More on Branches . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

4.6 Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 554.7 Long activity description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 564.8 Notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 574.9 Partition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 584.10 T itle the diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 594.11 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 604.12 C omplete example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

5 Component Diagram 63

5.1 Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 635.2 Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 645.3 Basic example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 655.4 Using notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 665.5 Grouping Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 675.6 Changing arrows direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 685.7 Title the diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 695.8 Skinparam . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70

6 State Diagram 71

6.1 Simple State . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 716.2 Composite state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 726.3 Long name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 736.4 Concurrent state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 746.5 Arrow direction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 756.6 Note . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76

6.7 More in notes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77

7 Objects Diagram 78

7.1 Definition of objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787.2 Relations between objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 787.3 Adding fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

8 Common commands 80

8.1 Footer and header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 808.2 Zoom . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 818.3 Rotation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82

9 Changing fonts and colors 83

plantuml language reference guide

Documents