PlantUML

2014-7, Leo Liang

actor useruser -> access ++ : getInfo() access -> access : authentication() access -> backend ++ : getInfo() backend -> dataStore : query() returnreturn

WriteDraw

› Writing is sometimes easy than drawing– Keyboard typing is faster than mouse dragging– Copy and paste– Auto layout on generation

› Text is manageable than binary– Keep UML source inside code (javadoc) or document (slides etc.)

› Convenient for update afterward

– Track change by version control system› Merge is possible

– Integrate with other system, e.g. IDE, content management system.

Why Text Based?

› Support all common UML diagrams– Sequence diagram Most Useful

– Class/object diagram Limitation in big diagram

– Use case diagram– Activity diagram / flow chart– Component diagram– State diagram

Yet Powerful

Sequence

actor userboundary accessparticipant backenddatabase dataStore

user -> access ++ : getInfo() access -> access : authentication() note right: HTTP Basic or Digest access -> backend ++ : getInfo() loop for info categories backend -> dataStore : query() end returnreturn

Class

hide empty fieldshide empty methods

class InvocationHistoryAspect <<aspect>>

class InvocationHistoryRecorder { + start(methodName): InvocationContext}

class InvocationContext { + finished(): void}

interface SamplingPolicyclass TimeBasedSampling implements SamplingPolicyclass NumberBasedSampling implements SamplingPolicy

InvocationHistoryRecorder .> InvocationContextInvocationContext ..> InvocationHistoryInvocationHistoryAspect --> InvocationHistoryRecorderInvocationHistoryInterceptor --> InvocationHistoryRecorderInvocationHistoryRecorder --> SamplingPolicy

Activity

start

if (graphviz installed?) then (yes) :process all diagrams;else (no) :process only sequence and activity diagrams;endif

stop

Component

node "Exposure" { PxMessaging -- [Messaging] PxLocation -- [Location] [Property Access CF][Messaging] -> [Property Access CF][Location] -> [Property Access CF]} node "Biz Admin" { GProvI -- [Provisioning]}

database "MySql" { folder "SIG-DB" { [Common Entities] }}

[Provisioning] --> [Common Entities][Property Access CF] --> [Common Entities]

State

[*] --> NotShooting

state NotShooting { [*] --> Idle Idle --> Configuring : EvConfig Configuring --> Idle : EvConfig}

state Configuring { [*] --> NewValueSelection NewValueSelection --> NewValuePreview : EvNewValue NewValuePreview --> NewValueSelection : EvRejected NewValuePreview --> NewValueSelection : EvSaved state NewValuePreview { State1 -> State2 }}

› Project home: document, download– http://www.plantuml.com/

› Online editor– http://www.plantuml.com/plantuml/form– http://www.planttext.com/planttext

› Integration– Eclipse: http://www.plantuml.com/eclipse.html– Jekyll: https://github.com/yjpark/jekyll-plantuml – More… http://www.plantuml.com/running.html

Resources