Skip to content

kaoh/javaclassestoplantuml

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

This library generates PlantUML class diagrams from Java classes.

Features

The library in its current state was created for getting a data model presentation of entities or DTOs.

This is the first version and has the following limitations:

  • No methods are included
  • No generics on classes are considered
  • Only the passed package is scanned and no outside package
  • It might be nice to add documentation based on supplied sources
  • it might be nice to support some stereotypes based on existing annotation

Usage

        String dbModel = new Converter("mypackage.foo.bar", Arrays.asList("myIncludeRegEx"), Arrays.asList("myExcludeRegEx")).convert();
        FileUtils.writeStringToFile(new File(dbModel.pu"), dbModel, StandardCharsets.UTF_8);

Take note that classes are ending with .class when giving includes and excludes.

Maven Dependency

    <groupId>de.ohmesoftware</groupId>
    <artifactId>classestoplantuml</artifactId>
    <version>0.0.3-SNAPSHOT</version>

Deployment + Release

See https://central.sonatype.org/pages/apache-maven.html

For Snapshots

mvn clean deploy

For Releases

mvn release:clean release:prepare
mvn release:perform

Release the deployment using Nexus See https://central.sonatype.org/pages/releasing-the-deployment.html Or alternatively do it with Maven:

cd target/checkout
mvn nexus-staging:release

About

Java classes to PlantUML converter

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages