What is this?

this is a simple staruml generator build for BUAA OO Unit-4 in order to avoid stupid typing mistakes during mid-tests. It can generate staruml file based on java source file.

this project is based on JavaParser and org.JSON, and import them with Maven.

Version Info

updated to v1.1

Feature Supported

• class diagrams
• Statechart diagram
• class and interface declaration
• attributes and operations of class or declaration and their basic modifier.
• Realization, Generalization and Aggregation relationships are supported.
• better Modifier
• InitState and FinalState supported.
• remove java source in package com.oocourse.

the following feature is not yet supported

• enumerable declaration. (because most people just don't have them in U4)
• sequence diagram support
• private class.

Usage

just build it and run Main.main.

FAQ

1. where's the diagram? I see a blank sheet.

You will need to drag them from the frame on the left explorer to your workspace, and design on your own. This project only meant to avoid making stupid typing mistakes.

As for state chart and other chart, you will need to double-click on them on the explorer on your left, and choose the diagram you want to design by double-clicking them on the left.

2. New to Maven?

you can also download Release at the release page.

3. How to use InitState and FinalState.

just change the name of the state into "InitState" or "FinalState" will do.

4. unable to identify Trigger and Triggers?

umlgenerator only support the Trigger and Triggers annotation that is written in key-value form. For example, your annotation should be like this:

public class Library {
    @Trigger(from = "State1", to = {"State2", "State3"})
    @Trigger(from = "State2", to = "State3")
    public void method1() {
        
    }
    
    @Triggers(value = {
        @Trigger(from = "State2", to = "State3"),
        @Trigger(from = "State3", to = {"State2", "State1"})
    })
    public void method2() {
        
    }
}

Also, the oocourse's TAs also suggest don't use Triggers annotation directly.

5. The uml.mdj file look ugly. Is there a way to reformat it?

Unfortunately, no. However, there is a simple way: open it with StarUML and save the file.

6. I cannot still cannot pass the test.

version 1.2 remove sendMessage support, because it cannot be done through sendMessage annotation. You have to draw it on your own. Good luck.