Skip to content

Klotzi111/plantuml-builder

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Build Status Make a pull request License Maven Central

Plantuml builder

Tools to generate plantuml diagram from java sources.

This generated diagrams are an important part of the Living Documentation tool

class diagram

This code :

String diagram = new ClassDiagramBuilder()
        .addClasses(Vehicule.class, Car.class, Driver.class, Price.class, Wheel.class, Devise.class)
        .build();

Will get :

@startuml

+class "Car" {
  -ignored : Long
  -brand : String
  -model : String
  -drivers : Set<Driver>
  -price : Price
  -wheels : Collection<Wheel>
  +addDriver(Driver) : Car
  +addWheel(Wheel)
  +buyBy(Driver, BigDecimal, Devise) : Driver
}

+enum "Devise" {
  +CHF
  +EUR
  +USD
}

+class "Driver" {
  -name : String
  -ignored : Long
  -cars : List<Car>
  +addCar(Car)
  +buy(Car)
}

+class "Price" {
  -amount : BigDecimal
  -devise : Devise
}

+interface "Vehicule" {
}

+class "Wheel" {
}

"Car" --> "Devise" : use
"Car" "*" <-> "*" "Driver" : drivers/cars
"Car" --> "Price" : price
"Car" --> "*" "Wheel" : wheels
"Price" --> "Devise" : devise
"Vehicule" <|-- "Car"

@enduml
Asciidoctor Diagram classes diagram

For more uses cases, more options see ClassDiagramBuilderTest or PlantUmlBuilderTest classes

About

Plantuml diagram from java sources

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Java 96.2%
  • Shell 3.8%