JarCasting
JarCasting JarCasting

Classes to PlantUML Converter

This library generates PlantUML class diagrams from Java classes.

License

License
Categories

Categories

Ant Build Tools UML Business Logic Libraries Documents Processing
GroupId

GroupId

de.ohmesoftware
ArtifactId

ArtifactId

classestoplantuml
Last Version

Last Version

0.0.4
Release Date

Release Date
Type

Type

jar
Description

Description

Classes to PlantUML Converter
This library generates PlantUML class diagrams from Java classes.
Project URL

Project URL

https://github.com/kaoh/javaclassestoplantuml
Source Code Management

Source Code Management

https://github.com/kaoh/javaclassestoplantuml/tree/master

Download classestoplantuml

Filename Size
classestoplantuml-0.0.4.pom
classestoplantuml-0.0.4.jar 6 KB
classestoplantuml-0.0.4-sources.jar 4 KB
classestoplantuml-0.0.4-javadoc.jar 23 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/de.ohmesoftware/classestoplantuml/ -->
<dependency>
    <groupId>de.ohmesoftware</groupId>
    <artifactId>classestoplantuml</artifactId>
    <version>0.0.4</version>
</dependency>
// https://jarcasting.com/artifacts/de.ohmesoftware/classestoplantuml/
implementation 'de.ohmesoftware:classestoplantuml:0.0.4'
// https://jarcasting.com/artifacts/de.ohmesoftware/classestoplantuml/
implementation ("de.ohmesoftware:classestoplantuml:0.0.4")
'de.ohmesoftware:classestoplantuml:jar:0.0.4'
<dependency org="de.ohmesoftware" name="classestoplantuml" rev="0.0.4">
  <artifact name="classestoplantuml" type="jar" />
</dependency>
@Grapes(
@Grab(group='de.ohmesoftware', module='classestoplantuml', version='0.0.4')
)
libraryDependencies += "de.ohmesoftware" % "classestoplantuml" % "0.0.4"
[de.ohmesoftware/classestoplantuml "0.0.4"]

Dependencies

compile (1)

Group / Artifact Type Version
org.reflections : reflections jar 0.9.11

test (1)

Group / Artifact Type Version
junit : junit jar 4.12

Project Modules

There are no modules declared in this project.

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

Versions

Version
0.0.4
0.0.3
0.0.2