Sequence Diagram is tool to generate simple sequence diagram(UML) from java, kotlin, scala(Beta) and groovy(limited) code. https://vanco.github.io/SequencePlugin.
with this plugin, you can
- generate Simple Sequence Diagram.
- Navigate the code by click the diagram shape.
- Delete Class from diagram.
- Export the diagram as image(SVG, JPEG, PNG, TIFF).
- Export the diagram as PlantUML, Mermaid format file.
- Exclude classes from diagram by Settings > Tools > Sequence Diagram
- Smart Interface(experimental)
- Lambda Expression(experimental)
- Kotlin Support(Experimental)
- Scala support(Experimental, Beta)
- Groovy Support(Experimental, limited)
The experimental features created by myself, which is not part of UML standard. Use this feature in your own risk.
SequenceDiagram version 3.x will use UAST api to generate sequence diagram.
Refer to 'The UAST description from IntelliJ Platform SDK'
UAST (Unified Abstract Syntax Tree) is an abstraction layer on the PSI of different programming languages targeting the JVM (Java Virtual Machine). It provides a unified API for working with common language elements like classes and method declarations, literal values, and control flow operators.
Which languages are supported?
- Java: full support
- Kotlin: full support
- Scala: beta, but full support
- Groovy: declarations only, method bodies not supported
Note : There are some limitation when generate from scala or groovy code. Refer to the list of known issues.
Find the implementation of the interface smartly. e.g.
publicinterfaceFruit {
inteat();
}
publicclassAppleimplementsFruit {
@Overridepublicinteat() {
return5;
}
}Apple implemented the Fruit interface. When we generate sequence diagram for the eatFruit method:
publicclassPeople {
privateFruitfruit = newApple();
publicvoideatFruit() {
fruit.eat();
}
}I draw dummy implementation call in dash line.
For the interface or abstract class, if there is only one implementation found, it will draw in diagram automatically. More than one implementation, you need to choose one to draw. this is an option in settings.
No standard for the lambda expression in the sequence diagram yet. So I create mine. e.g.
publicinterfaceService<Int, String> {
Stringinvoke(Inta);
}I need draw the sequence diagram for hello method:
publicclassLambda {
publicService<Integer, String> hello() {
returna -> {
Fruitfruit = newApple();
fruit.eat();
return"I'm good!";
};
}
}I draw a dummy () -> self call in diagram.
Sequence Diagram can generate sequence diagram from JAVA, Kotlin, Scala, Groovy File.
- Open Java/Kotlin/Scala/Groovy file
- Generate SequenceDiagram with shortcut
Alt Sfor windows,Option Sfor macOS
Please try to experience it and find what happen.
Have fun!
Current Version
| Open API | v2.x.x | v3.x |
|---|---|---|
| IGenerator | SequenceGenerator KtSequenceGenerator | UastSequenceGenerator |
| GeneratorFactory | JavaGeneratorFactory KtGeneratorFactory | UastGeneratorFactory |
| ElementTypeFinder | JavaElementTypeFinder KtElementTypeFinder | |
| ActionFinder | JavaActionFinder KtActionFinder | UastActionFinder |
| SequenceNavigable | JavaSequenceNavigable KtSequenceNavigable | JavaSequenceNavigable1 |
| v2.x.x | 3.x | |
|---|---|---|
| Language: | ||
| Java | ✓ | ✓ |
| Kotlin | ✓ Partial | ✓ |
| Scala | ✓ | |
| Groovy | ✓ Partial | |
| Entry: | ||
| Navigation Bar | ✓ | |
| Tools Menu | ✓ | ✓ |
| Editor Context Menu | ✓ | ✓ |
Shortcut Alt S for windows Option S for macOS | ✓ | |
| Project view popup menu | ||
| Structure view popup menu | ||
| Feature: | ||
| Smart Interface2 | ✓ EXC: 2.2.4, 2.2.5 | ✓ |
| Smart Interface configuration | ✓ | |
| Lambda call configuration | ✓ | ✓ |
For example:
classB() {
defbar() =Option("bar")
}
classA(b: B) {
deffoo() = {
valr="foo"+ b.bar().getOrElse("?")
r
}
deffoo2() = {
valr=for {
x <- b.bar()
} yield"foo"+ x
r.getOrElse("?")
}
}the for comprehension call
valr=for {
x <- b.bar()
} yield"foo"+ xit's UAST tree is UastEmptyexpression.
UMethod (name = foo2)
UBlockExpression
UDeclarationsExpression
ULocalVariable (name = r)
UastEmptyExpression(type = PsiType:Option<String>)
UReturnExpression
UQualifiedReferenceExpression
USimpleNameReferenceExpression (identifier = r)
UMethodCall(name = getOrElse)
UIdentifier (Identifier (getOrElse))
ULiteralExpression (value = "?")
so the b.bar() method call will not generate base on UastEmptyexpression. Hopefully, the UAST api will solve this problem sooner.
For example:
/** * A Class description*/classStudent {
/** the name of the person */String name
/** * Creates a greeting method for a certain person. * * @param otherPerson the person to greet * @return a greeting message*///known issue: groovy method will not generate in UASTStringgreet(StringotherPerson) {
"Hello ${otherPerson}"// call javaFruit fruit =newBanana()
fruit.eat()
}
}Based on UAST api limitation, it's UAST tree is no method body mappings.
UFile (package = van.demo.grovvy)
UClass (name = Student)
UMethod (name = greet)
UParameter (name = otherPerson)
When generate sequence of method greet, the calls in the method body will not generate (the call java code in the body of greet).
"Hello ${otherPerson}"// call javaFruit fruit =newBanana()
fruit.eat()- SequencePlugin Maintained by Kentaur(Kesh Sibilev, ksibilve@yahoo.com) until 2011
- SequencePluginReload Maintained by Vanhg(Evan Fan, fanhuagang@gmail.com) 2011 - 2015
- SequenceDiagram Maintained by Vanco(Evan Fan, fanhuagang@gmail.com) since 2016
{:height="32px" width="32px"}
Since 2011, I found a solution of NPE of original SequencePlugin, so I write email to Kentaur with my solution, He said he was not coding anymore. Instead, he sent me the code. I fix the NPE issue and publish to plugin repository with new name SequencePluginReload.
In 2015, the IntelliJ change the login system, and I lost my account, cannot continue to publish new version to the repository.
In 2016, I change the Name again to SequenceDiagram and host the source code on github. Now it is open source.
Thanks Kentaur for the great work on the original source.