Skip to content
Mike Ahlers edited this page Sep 27, 2019 · 9 revisions

Concept

Analyse any Java library and know exactly what it does contain on technical level.

Usually, a Java library is without documentation, let alone technical documentation. With technical documentation, I mean the class diagrams, sequence diagrams, component diagrams and which patterns are used. Knowing this, can aid software design, as in finding the right solution for your problem.

In addition, the analysis will also offer a clue of how the library can be used. With that I really mean deployment. For example, it will discover whether it is OSGI compliant for example. If that is the case, it can be deployed in an OSGI container.

Target

Build a component that is capable of analysing a single Java library and writing an output (as report) in a well defined structure (XML format, validated against a XSD).

References

TODO:

Architecture

TODO

Technical documentation

TODO

TODO: navigate over connections between classes (interactive class diagram) navigate over connections between sequences (same as above)

TODO: when generating class diagrams: use colors to highlight usage of annotations, for example: JAXB -> blue Json -> green JAXB + Json -> blue/green stripes?

TODO: research algo, force directed graph