-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
-<html>\r
-<head>\r
-<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">\r
-<title>JavaInspect</title>\r
-</head>\r
-<body>\r
- <h1>JavaInspect - Utility to visualize java software</h1>\r
- <a\r
- href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download</a>\r
- \r
- <a\r
- href="http://www2.svjatoslav.eu/gitbrowse/javainspect/doc/index.html">Online\r
- homepage</a> \r
- <a href="http://svjatoslav.eu/programs.jsp">Other applications\r
- hosted on svjatoslav.eu</a>\r
- <pre>\r
-<b>Program author:</b>\r
- Svjatoslav Agejenko\r
- Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>\r
- Email: <a href="mailto:svjatoslav@svjatoslav.eu">svjatoslav@svjatoslav.eu</a>\r
-\r
-This software is distributed under <a href="http://www.gnu.org/copyleft/lesser.html">GNU LESSER GENERAL PUBLIC LICENSE version 3 or later</a>.\r
-\r
-</pre>\r
-\r
- <h2>General</h2>\r
-\r
- Goal: simplify/speed up understanding the computer program code by\r
- automatically visualizing its structure.\r
- \r
- <br/><br/>\r
- JavaInspect is a Java library that you can embed into your Java project\r
- with a few lines of Maven configuration and then visualize any part of\r
- your Java program structure with few simple JavaInspect API calls at\r
- application runtime.\r
-\r
- <br />\r
- <br /> JavaInspect uses Java reflection to discover class relations and\r
- structure and produces GraphViz dot file that describes your\r
- application. Then launches GraphViz to generate bitmap graph in PNG\r
- format on your Desktop directory.\r
-\r
-\r
- <h2>Current status</h2>\r
-\r
- This is simple utility, quickly written. Tested on Linux (can be\r
- relatively simply ported to other operating systems too). So far I used\r
- it for my own needs. There might be bugs and missing features. Feedback\r
- and code contributions are welcome.\r
-\r
-\r
- <h2>Example graphs</h2>\r
-\r
- Example visualization of\r
- <a href="http://www2.svjatoslav.eu/gitbrowse/sixth/doc/">Sixth</a>\r
- project:\r
- <a\r
- href="http://www2.svjatoslav.eu/gitbrowse/sixth/doc/architecture%20graphs/index.html">architecture\r
- graphs</a>\r
-\r
- <br />\r
- <br /> A very simple example:\r
- <br />\r
- <a href="example.png"><img src="example.resized.png" /></a>\r
-\r
- <br /> Graph legend:\r
- <br />\r
- <img src="legend.png" />\r
-\r
-\r
- <h2>Usage example 1</h2>\r
-\r
-<pre>\r
-<code>\r
- /*\r
- * This example demonstrates generating of class graph from hand picked\r
- * classes.\r
- */\r
-\r
- // Create graph\r
- final ClassGraph graph = new ClassGraph();\r
-\r
- // While classes and objects can be immediately passed to ClassGraph\r
- // constructor as arguments, it is also possible to add then one by one\r
- // as in the following example.\r
-\r
- // Add some object to the graph.\r
- graph.addObject(graph);\r
-\r
- // Add some class to the graph.\r
- graph.addClass(Utils.class);\r
-\r
- // Produce bitmap image titled "JavaInspect.png" to the user Desktop\r
- // directory and keep intermediary GraphViz DOT file for reference.\r
- graph.generateGraph("JavaInspect", true);\r
-</code>\r
-\r
-\r
-Result:\r
- Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a>\r
- Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a>\r
-\r
-</pre>\r
-\r
-\r
- <h2>Usage example 2</h2>\r
-\r
-<pre>\r
-<code>\r
- // Recursively scan current directory for Java source code and attempt\r
- // to detect class names from there to be added to the graph.\r
- graph.addProject(".");\r
-\r
- // Blacklist example classes from being shown on the graph\r
- graph.getFilter().blacklistClassPattern(\r
- "eu.svjatoslav.inspector.java.structure.example.*");\r
-\r
- // do not show single classes with no relationships on the graph\r
- graph.hideOrphanedClasses();\r
-\r
- // Produce bitmap image titled "JavaInspect full project.png" to the\r
- // user Desktop directory.\r
- graph.generateGraph("JavaInspect full project");\r
-</code>\r
-\r
-\r
-Result:\r
- Generated PNG image: <a href="JavaInspect full project.png">JavaInspect full project.png</a>\r
-\r
-</pre>\r
-\r
-\r
-\r
- <h2>Embedding JavaInspect in your project</h2>\r
- <pre>\r
-\r
-Declare JavaInspect as dependency:\r
-\r
- <dependencies>\r
-\r
- ...\r
-\r
- <dependency>\r
- <groupId>eu.svjatoslav</groupId>\r
- <artifactId>javainspect</artifactId>\r
- <version>1.3</version>\r
- </dependency>\r
- \r
- </dependencies>\r
- \r
- \r
- \r
-Add Maven repository to retrieve artifact from:\r
- \r
- <repositories>\r
- <repository>\r
- <id>svjatoslav.eu</id>\r
- <name>Svjatoslav repository</name>\r
- <url>http://www2.svjatoslav.eu/maven/</url>\r
- </repository>\r
- </repositories>\r
-</pre>\r
-\r
-\r
-\r
-\r
- <h2>Requirements</h2>\r
-\r
- <br>\r
- <a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on\r
- the computer.\r
-\r
-\r
-</body>\r
-</html>\r
+<!doctype html>
+<html lang="en">
+<head>
+<title>JavaInspect - Utility to visualize java software</title>
+<!-- 2019-01-19 Sat 00:30 -->
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1">
+<meta name="generator" content="Org-mode">
+<meta name="author" content="Svjatoslav Agejenko">
+<link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
+<style type="text/css">
+footer {background-color: #111 !important;}
+pre {background-color: #111; color: #ccc;}
+</style>
+<style type="text/css">
+/* org mode styles on top of twbs */
+
+html {
+ position: relative;
+ min-height: 100%;
+}
+
+body {
+ font-size: 18px;
+ margin-bottom: 105px;
+}
+
+footer {
+ position: absolute;
+ bottom: 0;
+ width: 100%;
+ height: 101px;
+ background-color: #f5f5f5;
+}
+
+footer > div {
+ padding: 10px;
+}
+
+footer p {
+ margin: 0 0 5px;
+ text-align: center;
+ font-size: 16px;
+}
+
+#table-of-contents {
+ margin-top: 20px;
+ margin-bottom: 20px;
+}
+
+blockquote p {
+ font-size: 18px;
+}
+
+pre {
+ font-size: 16px;
+}
+
+.footpara {
+ display: inline-block;
+}
+
+figcaption {
+ font-size: 16px;
+ color: #666;
+ font-style: italic;
+ padding-bottom: 15px;
+}
+
+/* from twbs docs */
+
+.bs-docs-sidebar.affix {
+ position: static;
+}
+@media (min-width: 768px) {
+ .bs-docs-sidebar {
+ padding-left: 20px;
+ }
+}
+
+/* All levels of nav */
+.bs-docs-sidebar .nav > li > a {
+ display: block;
+ padding: 4px 20px;
+ font-size: 14px;
+ font-weight: 500;
+ color: #999;
+}
+.bs-docs-sidebar .nav > li > a:hover,
+.bs-docs-sidebar .nav > li > a:focus {
+ padding-left: 19px;
+ color: #A1283B;
+ text-decoration: none;
+ background-color: transparent;
+ border-left: 1px solid #A1283B;
+}
+.bs-docs-sidebar .nav > .active > a,
+.bs-docs-sidebar .nav > .active:hover > a,
+.bs-docs-sidebar .nav > .active:focus > a {
+ padding-left: 18px;
+ font-weight: bold;
+ color: #A1283B;
+ background-color: transparent;
+ border-left: 2px solid #A1283B;
+}
+
+/* Nav: second level (shown on .active) */
+.bs-docs-sidebar .nav .nav {
+ display: none; /* Hide by default, but at >768px, show it */
+ padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav > li > a {
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 30px;
+ font-size: 12px;
+ font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav > li > a:focus {
+ padding-left: 29px;
+}
+.bs-docs-sidebar .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav > .active:focus > a {
+ padding-left: 28px;
+ font-weight: 500;
+}
+
+/* Nav: third level (shown on .active) */
+.bs-docs-sidebar .nav .nav .nav {
+ padding-bottom: 10px;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a {
+ padding-top: 1px;
+ padding-bottom: 1px;
+ padding-left: 40px;
+ font-size: 12px;
+ font-weight: normal;
+}
+.bs-docs-sidebar .nav .nav .nav > li > a:hover,
+.bs-docs-sidebar .nav .nav .nav > li > a:focus {
+ padding-left: 39px;
+}
+.bs-docs-sidebar .nav .nav .nav > .active > a,
+.bs-docs-sidebar .nav .nav .nav > .active:hover > a,
+.bs-docs-sidebar .nav .nav .nav > .active:focus > a {
+ padding-left: 38px;
+ font-weight: 500;
+}
+
+/* Show and affix the side nav when space allows it */
+@media (min-width: 992px) {
+ .bs-docs-sidebar .nav > .active > ul {
+ display: block;
+ }
+ /* Widen the fixed sidebar */
+ .bs-docs-sidebar.affix,
+ .bs-docs-sidebar.affix-bottom {
+ width: 213px;
+ }
+ .bs-docs-sidebar.affix {
+ position: fixed; /* Undo the static from mobile first approach */
+ top: 20px;
+ }
+ .bs-docs-sidebar.affix-bottom {
+ position: absolute; /* Undo the static from mobile first approach */
+ }
+ .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
+ margin-top: 0;
+ margin-bottom: 0
+ }
+}
+@media (min-width: 1200px) {
+ /* Widen the fixed sidebar again */
+ .bs-docs-sidebar.affix-bottom,
+ .bs-docs-sidebar.affix {
+ width: 263px;
+ }
+}
+</style>
+<script type="text/javascript">
+$(function() {
+ 'use strict';
+
+ $('.bs-docs-sidebar li').first().addClass('active');
+
+ $(document.body).scrollspy({target: '.bs-docs-sidebar'});
+
+ $('.bs-docs-sidebar').affix();
+});
+</script>
+</head>
+<body>
+<div id="content" class="container">
+<div class="row"><div class="col-md-9"><h1 class="title">JavaInspect - Utility to visualize java software</h1>
+
+<div id="outline-container-sec-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
+<div class="outline-text-2" id="text-1">
+<ul class="org-ul">
+<li>This program is free software: you can redistribute it and/or modify
+it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+</li>
+
+<li>Program authors:
+<ul class="org-ul">
+<li>Svjatoslav Agejenko
+<ul class="org-ul">
+<li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
+</li>
+<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
+</li>
+<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
+</li>
+</ul>
+</li>
+
+<li>Tony Bargnesi
+<ul class="org-ul">
+<li>GitHub fork for the project:
+<a href="https://github.com/abargnesi/javainspect">https://github.com/abargnesi/javainspect</a>
+</li>
+</ul>
+</li>
+</ul>
+</li>
+</ul>
+</div>
+
+<div id="outline-container-sec-1-1" class="outline-3">
+<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
+<div class="outline-text-3" id="text-1-1">
+<ul class="org-ul">
+<li><a href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
+</li>
+
+<li><a href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary">Browse Git repository online</a>
+</li>
+
+<li>Clone Git repository using command:
+<pre class="example">
+git clone https://www2.svjatoslav.eu/git/javainspect.git
+
+</pre>
+</li>
+</ul>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Goal and operating principle</h2>
+<div class="outline-text-2" id="text-2">
+<p>
+Goal: simplify/speed up understanding the computer program code by
+automatically visualizing its structure.
+</p>
+
+<p>
+<a href="http://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
+</p>
+
+<p>
+JavaInspect can be used as a <a href="#sec-4-1">standalone commandline utility</a> as well as
+<a href="#sec-4-2">java library</a>. JavaInspect uses primarily Java built-in reflection to
+discover and visualize any part of Java program.
+</p>
+
+<p>
+JavaInspect currently has no GUI, configuration files, embedded
+scripting support, direct Maven or Ant integration. See <a href="#sec-4">usage</a> to learn
+how to instuct Javainspect what to do.
+</p>
+
+<p>
+After discovering application structure and optionally filtering out
+unimportant parts, JavaInspect produces GraphViz dot file that
+describes data to be visualized. Then launches GraphViz to generate
+bitmap graph in PNG or SVG format.
+</p>
+
+<p>
+By default on your Desktop directory when operated in library mode or
+current working directory when operated as standalone commandline
+application.
+</p>
+
+<p>
+Notes:
+</p>
+<ul class="org-ul">
+<li>JavaInspect is developed and tested so far only on GNU/Linux.
+</li>
+<li>See: <a href="https://github.com/pahen/madge">Madge - similar tool for JavaScript</a>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> Example graphs</h2>
+<div class="outline-text-2" id="text-3">
+<ul class="org-ul">
+<li>A very simple example:
+
+<p>
+<a href="example.png">file:example.resized.png</a>
+</p>
+
+<p>
+Graph legend:
+</p>
+
+
+<figure>
+<p><img src="legend.png" class="img-responsive" alt="legend.png">
+</p>
+</figure>
+</li>
+
+<li><a href="http://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="http://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-4" class="outline-2">
+<h2 id="sec-4"><a id="ID-2ad2889e-6c95-4662-b3f4-2c341fc74522" name="ID-2ad2889e-6c95-4662-b3f4-2c341fc74522"></a><span class="section-number-2">4</span> Usage</h2>
+<div class="outline-text-2" id="text-4">
+<p>
+JavaInspect can be controlled in 2 different ways:
+</p>
+<ul class="org-ul">
+<li><a href="#sec-4-1">as standalone commandline utility</a>
+</li>
+<li><a href="#sec-4-2">as embedded Java library via Java API</a>
+</li>
+</ul>
+</div>
+
+<div id="outline-container-sec-4-1" class="outline-3">
+<h3 id="sec-4-1"><a id="ID-acf1896a-74b4-4914-acf6-a77075e07f25" name="ID-acf1896a-74b4-4914-acf6-a77075e07f25"></a><span class="section-number-3">4.1</span> usage as commandline utility</h3>
+<div class="outline-text-3" id="text-4-1">
+<p>
+To enable commandline support, (study and) execute script:
+</p>
+<pre class="example">
+commandline launcher/install
+
+</pre>
+
+<p>
+Warning: It was tested only on Debian Stretch linux.
+</p>
+
+<p>
+Available commandline arguments:
+</p>
+<p class="verse">
+-j (existing files)…<br >
+    JAR file(s) to render.<br >
+<br >
+-n (mandatory, string)<br >
+    Graph name.<br >
+<br >
+–debug<br >
+    Show debug info.<br >
+<br >
+-k<br >
+    Keep dot file.<br >
+<br >
+-h<br >
+    Hide orphaned classes.<br >
+<br >
+-w (one to many strings)…<br >
+    Whitelist glob(s).<br >
+<br >
+-b (one to many strings)…<br >
+    Blacklist glob(s).<br >
+<br >
+-d (existingdirectory)<br >
+    Target directory. Default is current directory.<br >
+<br >
+-t (options: png, svg)<br >
+    Target image type. Default is: svg.<br >
+</p>
+</div>
+</div>
+<div id="outline-container-sec-4-2" class="outline-3">
+<h3 id="sec-4-2"><a id="ID-bbeeffc8-3767-440d-8d93-ec9124dd60ee" name="ID-bbeeffc8-3767-440d-8d93-ec9124dd60ee"></a><span class="section-number-3">4.2</span> usage via Java API</h3>
+<div class="outline-text-3" id="text-4-2">
+<p>
+Requires that classes to be visualised are available in the classpath.
+</p>
+
+<p>
+To get JavaInspect into same classpath with your projecs I so far came
+up with 2 solutions:
+</p>
+
+<ol class="org-ol">
+<li>Add JavaInspect library in your project as a dependency.
+</li>
+
+<li>Create new Java project for the purpose visualizing your other
+projects and include JavaInspect and your projecs binary artifacts
+(Jar's) into new project classpath. Built binary Jar's (with no
+source code) are sufficient because JavaInspect operates via
+reflection.
+</li>
+</ol>
+
+<p>
+Simple Java based control/configuration code needs to be written for
+each project. I usually put such code into directories devoted for
+JUnit tests. Because it needs not to be compiled/embedded into final
+product or project artifact I'm just willing to visualize.
+</p>
+
+<p>
+Control code in general does the following:
+</p>
+<ol class="org-ol">
+<li>Create graph object.
+</li>
+<li>Java reflection/classloaders does not provide mechanism for
+discovering all classes under given package. Therefore you need to
+declare at least some classes to be added to the graph by:
+<ul class="org-ul">
+<li>Manually adding individual classes to the graph.
+</li>
+<li>and/or: Let GraphViz recursively scan and parse specified
+directories with Java source code files to discover class names.
+</li>
+<li>For every class added to the graph, GraphViz will recursively
+inspect it and add all referecned classes to the graph as well.
+</li>
+</ul>
+</li>
+<li>Graphs easilly get very big and complex so optionally we filter
+important code using classname wildcards patterns based blacklist
+and/or whitelist.
+</li>
+<li>Optionally we can tune some rendering parameters like:
+<ul class="org-ul">
+<li>Possibility to remove orphaned classes (classes with no
+references) from the graph.
+</li>
+<li>Specify target directory for generated visualization
+files. (Default is user desktop directory)
+</li>
+<li>Keep intermediate GraphViz dot file for later inspection.
+</li>
+</ul>
+</li>
+<li>Render graph.
+</li>
+</ol>
+</div>
+
+
+<div id="outline-container-sec-4-2-1" class="outline-4">
+<h4 id="sec-4-2-1"><span class="section-number-4">4.2.1</span> example 1: individually picked objects</h4>
+<div class="outline-text-4" id="text-4-2-1">
+<p>
+This example demonstrates generating of class graph from hand picked
+classes and visualizing GraphViz itself.
+</p>
+
+<div class="org-src-container">
+
+<pre class="src src-java">
+// Create graph
+final ClassGraph graph = new ClassGraph();
+
+// Add some random object to the graph. GraphViz will detect Class from
+// the object.
+graph.add(graph);
+
+// Also add some random class to the graph.
+graph.add(Utils.class);
+
+// Keep intermediary GraphViz DOT file for reference.
+graph.setKeepDotFile(true);
+
+// Produce bitmap image titled "JavaInspect.png" to the user Desktop
+// directory
+graph.generateGraph("JavaInspect");
+
+</pre>
+</div>
+
+<p>
+Note: if desired, more compact version of the above:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-java">new ClassGraph().add(randomObject, RandomClass.class)
+ .setKeepDotFile(true).generateGraph("JavaInspect");
+</pre>
+</div>
+
+
+<p>
+Result:
+</p>
+<ul class="org-ul">
+<li>Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a>
+</li>
+<li>Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-4-2-2" class="outline-4">
+<h4 id="sec-4-2-2"><span class="section-number-4">4.2.2</span> example 2: scan java code, apply filters</h4>
+<div class="outline-text-4" id="text-4-2-2">
+<div class="org-src-container">
+
+<pre class="src src-java">// Create graph
+final ClassGraph graph = new ClassGraph();
+
+// Recursively scan current directory for Java source code and attempt
+// to detect class names from there to be added to the graph.
+graph.addProject(".");
+
+// Blacklist example classes from being shown on the graph
+graph.blacklistClassPattern("eu.svjatoslav.inspector.java.structure.example.*");
+
+// do not show single classes with no relationships on the graph
+graph.hideOrphanedClasses();
+
+// Produce bitmap image titled "JavaInspect full project.png" to the
+// user Desktop directory.
+graph.generateGraph("JavaInspect full project");
+</pre>
+</div>
+<p>
+Result:
+</p>
+<ul class="org-ul">
+<li>Generated PNG image: <a href="JavaInspect%20full%20project.png">JavaInspect full project.png</a>
+</li>
+</ul>
+</div>
+</div>
+
+<div id="outline-container-sec-4-2-3" class="outline-4">
+<h4 id="sec-4-2-3"><span class="section-number-4">4.2.3</span> example 3: GraphViz embedded in another project</h4>
+<div class="outline-text-4" id="text-4-2-3">
+<ol class="org-ol">
+<li>Download project Sixth <a href="http://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz">code snapshot</a>.
+</li>
+<li>Inspect and run *DataGraph.java*.
+</li>
+</ol>
+</div>
+</div>
+
+<div id="outline-container-sec-4-2-4" class="outline-4">
+<h4 id="sec-4-2-4"><span class="section-number-4">4.2.4</span> Embedding JavaInspect in your Maven project</h4>
+<div class="outline-text-4" id="text-4-2-4">
+<p>
+Declare JavaInspect as dependency:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-xml"><dependencies>
+ ...
+ <dependency>
+ <groupId>eu.svjatoslav</groupId>
+ <artifactId>javainspect</artifactId>
+ <version>1.6</version>
+ </dependency>
+ ...
+</dependencies>
+</pre>
+</div>
+
+
+<p>
+Add Maven repository to retrieve artifact from:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-xml"><repositories>
+ ...
+ <repository>
+ <id>svjatoslav.eu</id>
+ <name>Svjatoslav repository</name>
+ <url>http://www2.svjatoslav.eu/maven/</url>
+ </repository>
+ ...
+</repositories>
+</pre>
+</div>
+</div>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-5" class="outline-2">
+<h2 id="sec-5"><span class="section-number-2">5</span> Requirements</h2>
+<div class="outline-text-2" id="text-5">
+<p>
+<a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on the computer.
+</p>
+
+<p>
+On Ubuntu/Debian use:
+</p>
+<div class="org-src-container">
+
+<pre class="src src-sh">sudo apt-get install graphviz
+</pre>
+</div>
+</div>
+</div>
+<div id="outline-container-sec-6" class="outline-2">
+<h2 id="sec-6"><span class="section-number-2">6</span> TO DO</h2>
+<div class="outline-text-2" id="text-6">
+<p>
+Note: Because this is side project (and I have many of them) I can
+only contribute few hours per year at average. Any help is welcome. A
+LOT of cool ideas could be implemented. For intstance:
+</p>
+
+<ul class="org-ul">
+<li>BUG: Should not hide references if there are too many of them to
+classes if referring classes are not visible anyway because of
+blacklist/whitelist rules. Basically reference counting should
+exclude not visible classes.
+</li>
+
+<li>BUG: Orphaned class removal does not work always. There are many
+bugs and corner cases to find and fix still.
+</li>
+
+<li>BUG: Code is not very readable. Document and refactor for better
+maintainability.
+</li>
+
+<li>FEATURE: Create installable DEB package.
+<ul class="org-ul">
+<li>Submit it to some Debian developer for integration or become
+Debian package maintainer.
+</li>
+</ul>
+</li>
+
+<li>FEATURE: Make it modular. That is: central part, an application
+model could be standalone and serializable.
+
+<ul class="org-ul">
+<li>There could be multiple ways to acquire model:
+<ul class="org-ul">
+<li>By introspecting application via Java reflections (current mode
+of operation).
+</li>
+<li>By parsing java source. (unfinished)
+</li>
+</ul>
+</li>
+
+<li>There could be ways to manipulate model:
+<ul class="org-ul">
+<li>Store/load/compare.
+</li>
+<li>Trim uninteresting parts.
+</li>
+<li>Highlight important parts.
+</li>
+</ul>
+</li>
+
+<li>There could be multiple ways to render model:
+<ul class="org-ul">
+<li>PNG/SVG (currently implemented)
+</li>
+<li>PlantUML (TODO)
+</li>
+<li>Interactive 3D visualization (TODO)
+</li>
+</ul>
+</li>
+</ul>
+</li>
+
+<li>FEATURE: Replace internal java parser in package
+eu.svjatoslav.inspector.java.methods with: <a href="https://javaparser.org/">https://javaparser.org/</a>
+</li>
+
+<li>FEATURE: Integarte with <a href="http://plantuml.com/class-diagram">PlantUML</a>.
+</li>
+
+<li>FEATURE: Add dark theme for generated graphs.
+</li>
+
+<li>FEATURE: Sort Class fields by alphabet.
+</li>
+
+<li>FEATURE: Visualize also concrete field values so it could be used as
+ultra cool runtime logging/debugging framework.
+</li>
+
+<li>FEATURE: Possibility to visualize structure and data from JVM
+snapshot.
+</li>
+
+<li>FEATURE: Possibility to attach to remote process to visualize
+data/structure using JVM debug port and mechanism.
+</li>
+
+<li>FEATURE: Possibility to attach to JVM using JVM agent.
+</li>
+
+<li>FEATURE: Possibility to inspect graphs in 3D using <a href="http://www2.svjatoslav.eu/gitbrowse/sixth-3d/doc/index.html">Sixth 3D engine</a>.
+</li>
+
+<li>FEATURE: Possibility to select classes/fields/values to be
+visualized in some graph query language. For greater flexibility in
+comparison to currently supported glob syntax.
+</li>
+
+<li>FEATURE: Add option to control JavaInspect via JSON or XML config
+file. For example different graphs for given project could be
+defined once in plain text config, possibly with the aid of some
+interactive utility. Then defined graphs could be updated as part of
+project build or release process.
+</li>
+
+<li>FEATURE: Configurable maven plugin to generate graphs as part of the
+project build/release process.
+</li>
+</ul>
+</div>
+</div>
+</div><div class="col-md-3"><nav id="table-of-contents">
+<div id="text-table-of-contents" class="bs-docs-sidebar">
+<ul class="nav">
+<li><a href="#sec-1">1. General</a>
+<ul class="nav">
+<li><a href="#sec-1-1">1.1. Source code</a></li>
+</ul>
+</li>
+<li><a href="#sec-2">2. Goal and operating principle</a></li>
+<li><a href="#sec-3">3. Example graphs</a></li>
+<li><a href="#sec-4">4. Usage</a>
+<ul class="nav">
+<li><a href="#sec-4-1">4.1. usage as commandline utility</a></li>
+<li><a href="#sec-4-2">4.2. usage via Java API</a></li>
+</ul>
+</li>
+<li><a href="#sec-5">5. Requirements</a></li>
+<li><a href="#sec-6">6. TO DO</a></li>
+</ul>
+</div>
+</nav>
+</div></div></div>
+<footer id="postamble" class="">
+<div><p class="author">Author: Svjatoslav Agejenko</p>
+<p class="date">Created: 2019-01-19 Sat 00:30</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="http://orgmode.org">Org-mode</a> 9.1.9)</p>
+</div>
+</footer>
+</body>
+</html>
projects / javainspect.git / blobdiff