JavaInspect - Utility to visualize java software
-Table of Contents
--
-
- 1. General +
- 1. General -
- 2. Goal and operating principle -
- 3. Example graphs -
- 4. Installation -
- 5. Usage +
- 2. Goal and operating principle +
- 3. Example graphs +
- 4. Installation +
- 5. Usage
-
-
- 5.1. Usage as commandline utility +
- 5.1. Usage as commandline utility -
- 5.2. Usage via Java API +
- 5.2. Usage via Java API
-
-
- 5.2.1. Example 1: individually picked objects -
- 5.2.2. Example 2: GraphViz embedded in another project -
- 5.2.3. Embedding JavaInspect in your Maven project +
- 5.2.1. Example 1: individually picked objects +
- 5.2.2. Example 2: GraphViz embedded in another project +
- 5.2.3. Embedding JavaInspect in your Maven project
- - 6. TO DO -
- 7. See also +
- 6. TO DO +
- 7. See also
1 General
+1. General
- This program is free software: you can redistribute it and/or modify @@ -289,8 +267,8 @@ License, or (at your option) any later version.
1.1 Source code
+1.1. Source code
- Download latest snapshot in TAR GZ format @@ -308,8 +286,8 @@ git clone https://www2.svjatoslav.eu/git/javainspect.git
2 Goal and operating principle
+2. Goal and operating principle
Goal: simplify/speed up understanding the computer program code by @@ -321,15 +299,15 @@ automatically visualizing its structure.
-JavaInspect can be used as a standalone commandline utility as well as -java library. JavaInspect uses primarily Java built-in reflection to +JavaInspect can be used as a standalone commandline utility as well as +java library. JavaInspect uses primarily Java built-in reflection to discover and visualize any part of Java program.
JavaInspect currently has no graphical user interface, configuration files, embedded scripting support, direct Maven, Gradle or Ant -integration. See usage to learn how to instuct Javainspect what to do. +integration. See usage to learn how to instuct Javainspect what to do.
@@ -348,8 +326,8 @@ Notes:
3 Example graphs
+3. Example graphs
@@ -357,7 +335,7 @@ A very simple example:
- --4 Installation
++-4. Installation
GraphViz - shall be installed on the computer. @@ -398,13 +376,13 @@ On Ubuntu/Debian GraphViz can be installed using:
To use JavaInspect via Java API, no further installation is needed. JavaInspect will be embedded into your project as dependency. -This is described in usage via Java API. It will expect GraphViz to be +This is described in usage via Java API. It will expect GraphViz to be available in the system.
To use JavaInspect as a commandline tool, JavaInspect source -repository has to be cloned locally: See Source code. +repository has to be cloned locally: See Source code.
@@ -432,24 +410,24 @@ javainspect --help
-5 Usage
++5. Usage
JavaInspect can be controlled in 2 different ways:
-5.1 Usage as commandline utility
++5.1. Usage as commandline utility
-5.1.1 Available commandline arguments
++-5.1.1. Available commandline arguments
-j (existing files)…
@@ -490,8 +468,8 @@ JavaInspect can be controlled in 2 different ways:-5.1.2 Specifying classes to render
++-5.1.2. Specifying classes to render
Normal Java application has immense complexity. In addition to code @@ -541,8 +519,8 @@ those also to the graph.
-5.2 Usage via Java API
++5.2. Usage via Java API
Requires that classes to be visualised are available in the classpath. @@ -597,8 +575,8 @@ files. (Default is current directory)
-5.2.1 Example 1: individually picked objects
++-5.2.1. Example 1: individually picked objects
This example demonstrates generating of class graph from hand picked @@ -647,8 +625,8 @@ Result:
-5.2.2 Example 2: GraphViz embedded in another project
++-5.2.2. Example 2: GraphViz embedded in another project
- Download project Sixth code snapshot. @@ -657,8 +635,8 @@ Result:
-5.2.3 Embedding JavaInspect in your Maven project
++-5.2.3. Embedding JavaInspect in your Maven project
Declare JavaInspect as dependency: @@ -686,7 +664,7 @@ Add Maven repository to retrieve artifact from: <repository> <id>svjatoslav.eu</id> <name>Svjatoslav repository</name> - <url>http://www2.svjatoslav.eu/maven/</url> + <url>http://www3.svjatoslav.eu/maven/</url> </repository> ... </repositories> @@ -697,8 +675,8 @@ Add Maven repository to retrieve artifact from:
-6 TO DO
++-6. TO DO
Note: Because this is side project (and I have many of them) I can @@ -789,8 +767,8 @@ project build/release process.
-7 See also
++7. See also
Similar or alternative solutions: @@ -804,7 +782,7 @@ Similar or alternative solutions: