doc/index.html

   1 <!doctype html>
   2 <html lang="en">
   3 <head>
   4 <title>JavaInspect - Utility to visualize java software</title>
   5 <!-- 2019-01-19 Sat 00:47 -->
   6 <meta charset="utf-8">
   7 <meta name="viewport" content="width=device-width, initial-scale=1">
   8 <meta name="generator" content="Org-mode">
   9 <meta name="author" content="Svjatoslav Agejenko">
  10 <link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
  11 <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
  12 <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
  13 <style type="text/css">
  14 footer {background-color: #111 !important;}
  15 pre {background-color: #111; color: #ccc;}
  16 </style>
  17 <style type="text/css">
  18 /* org mode styles on top of twbs */
  19
  20 html {
  21     position: relative;
  22     min-height: 100%;
  23 }
  24
  25 body {
  26     font-size: 18px;
  27     margin-bottom: 105px;
  28 }
  29
  30 footer {
  31     position: absolute;
  32     bottom: 0;
  33     width: 100%;
  34     height: 101px;
  35     background-color: #f5f5f5;
  36 }
  37
  38 footer > div {
  39     padding: 10px;
  40 }
  41
  42 footer p {
  43     margin: 0 0 5px;
  44     text-align: center;
  45     font-size: 16px;
  46 }
  47
  48 #table-of-contents {
  49     margin-top: 20px;
  50     margin-bottom: 20px;
  51 }
  52
  53 blockquote p {
  54     font-size: 18px;
  55 }
  56
  57 pre {
  58     font-size: 16px;
  59 }
  60
  61 .footpara {
  62     display: inline-block;
  63 }
  64
  65 figcaption {
  66   font-size: 16px;
  67   color: #666;
  68   font-style: italic;
  69   padding-bottom: 15px;
  70 }
  71
  72 /* from twbs docs */
  73
  74 .bs-docs-sidebar.affix {
  75     position: static;
  76 }
  77 @media (min-width: 768px) {
  78     .bs-docs-sidebar {
  79         padding-left: 20px;
  80     }
  81 }
  82
  83 /* All levels of nav */
  84 .bs-docs-sidebar .nav > li > a {
  85     display: block;
  86     padding: 4px 20px;
  87     font-size: 14px;
  88     font-weight: 500;
  89     color: #999;
  90 }
  91 .bs-docs-sidebar .nav > li > a:hover,
  92 .bs-docs-sidebar .nav > li > a:focus {
  93     padding-left: 19px;
  94     color: #A1283B;
  95     text-decoration: none;
  96     background-color: transparent;
  97     border-left: 1px solid #A1283B;
  98 }
  99 .bs-docs-sidebar .nav > .active > a,
 100 .bs-docs-sidebar .nav > .active:hover > a,
 101 .bs-docs-sidebar .nav > .active:focus > a {
 102     padding-left: 18px;
 103     font-weight: bold;
 104     color: #A1283B;
 105     background-color: transparent;
 106     border-left: 2px solid #A1283B;
 107 }
 108
 109 /* Nav: second level (shown on .active) */
 110 .bs-docs-sidebar .nav .nav {
 111     display: none; /* Hide by default, but at >768px, show it */
 112     padding-bottom: 10px;
 113 }
 114 .bs-docs-sidebar .nav .nav > li > a {
 115     padding-top: 1px;
 116     padding-bottom: 1px;
 117     padding-left: 30px;
 118     font-size: 12px;
 119     font-weight: normal;
 120 }
 121 .bs-docs-sidebar .nav .nav > li > a:hover,
 122 .bs-docs-sidebar .nav .nav > li > a:focus {
 123     padding-left: 29px;
 124 }
 125 .bs-docs-sidebar .nav .nav > .active > a,
 126 .bs-docs-sidebar .nav .nav > .active:hover > a,
 127 .bs-docs-sidebar .nav .nav > .active:focus > a {
 128     padding-left: 28px;
 129     font-weight: 500;
 130 }
 131
 132 /* Nav: third level (shown on .active) */
 133 .bs-docs-sidebar .nav .nav .nav {
 134     padding-bottom: 10px;
 135 }
 136 .bs-docs-sidebar .nav .nav .nav > li > a {
 137     padding-top: 1px;
 138     padding-bottom: 1px;
 139     padding-left: 40px;
 140     font-size: 12px;
 141     font-weight: normal;
 142 }
 143 .bs-docs-sidebar .nav .nav .nav > li > a:hover,
 144 .bs-docs-sidebar .nav .nav .nav > li > a:focus {
 145     padding-left: 39px;
 146 }
 147 .bs-docs-sidebar .nav .nav .nav > .active > a,
 148 .bs-docs-sidebar .nav .nav .nav > .active:hover > a,
 149 .bs-docs-sidebar .nav .nav .nav > .active:focus > a {
 150     padding-left: 38px;
 151     font-weight: 500;
 152 }
 153
 154 /* Show and affix the side nav when space allows it */
 155 @media (min-width: 992px) {
 156     .bs-docs-sidebar .nav > .active > ul {
 157         display: block;
 158     }
 159     /* Widen the fixed sidebar */
 160     .bs-docs-sidebar.affix,
 161     .bs-docs-sidebar.affix-bottom {
 162         width: 213px;
 163     }
 164     .bs-docs-sidebar.affix {
 165         position: fixed; /* Undo the static from mobile first approach */
 166         top: 20px;
 167     }
 168     .bs-docs-sidebar.affix-bottom {
 169         position: absolute; /* Undo the static from mobile first approach */
 170     }
 171     .bs-docs-sidebar.affix .bs-docs-sidenav,.bs-docs-sidebar.affix-bottom .bs-docs-sidenav {
 172         margin-top: 0;
 173         margin-bottom: 0
 174     }
 175 }
 176 @media (min-width: 1200px) {
 177     /* Widen the fixed sidebar again */
 178     .bs-docs-sidebar.affix-bottom,
 179     .bs-docs-sidebar.affix {
 180         width: 263px;
 181     }
 182 }
 183 </style>
 184 <script type="text/javascript">
 185 $(function() {
 186     'use strict';
 187
 188     $('.bs-docs-sidebar li').first().addClass('active');
 189
 190     $(document.body).scrollspy({target: '.bs-docs-sidebar'});
 191
 192     $('.bs-docs-sidebar').affix();
 193 });
 194 </script>
 195 </head>
 196 <body>
 197 <div id="content" class="container">
 198 <div class="row"><div class="col-md-9"><h1 class="title">JavaInspect - Utility to visualize java software</h1>
 199
 200 <div id="outline-container-sec-1" class="outline-2">
 201 <h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
 202 <div class="outline-text-2" id="text-1">
 203 <ul class="org-ul">
 204 <li>This program is free software: you can redistribute it and/or modify
 205 it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
 206 published by the Free Software Foundation, either version 3 of the
 207 License, or (at your option) any later version.
 208 </li>
 209
 210 <li>Program authors:
 211 <ul class="org-ul">
 212 <li>Svjatoslav Agejenko
 213 <ul class="org-ul">
 214 <li>Homepage: <a href="https://svjatoslav.eu">https://svjatoslav.eu</a>
 215 </li>
 216 <li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
 217 </li>
 218 <li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
 219 </li>
 220 </ul>
 221 </li>
 222
 223 <li>Tony Bargnesi
 224 <ul class="org-ul">
 225 <li>GitHub fork for the project:
 226 <a href="https://github.com/abargnesi/javainspect">https://github.com/abargnesi/javainspect</a>
 227 </li>
 228 </ul>
 229 </li>
 230 </ul>
 231 </li>
 232 </ul>
 233 </div>
 234
 235 <div id="outline-container-sec-1-1" class="outline-3">
 236 <h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
 237 <div class="outline-text-3" id="text-1-1">
 238 <ul class="org-ul">
 239 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
 240 </li>
 241
 242 <li><a href="https://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=summary">Browse Git repository online</a>
 243 </li>
 244
 245 <li>Clone Git repository using command:
 246 <pre class="example">
 247 git clone https://www2.svjatoslav.eu/git/javainspect.git
 248
 249 </pre>
 250 </li>
 251 </ul>
 252 </div>
 253 </div>
 254 </div>
 255
 256 <div id="outline-container-sec-2" class="outline-2">
 257 <h2 id="sec-2"><span class="section-number-2">2</span> Goal and operating principle</h2>
 258 <div class="outline-text-2" id="text-2">
 259 <p>
 260 Goal: simplify/speed up understanding the computer program code by
 261 automatically visualizing its structure.
 262 </p>
 263
 264 <p>
 265 <a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
 266 </p>
 267
 268 <p>
 269 JavaInspect can be used as a <a href="#sec-4-1">standalone commandline utility</a> as well as
 270 <a href="#sec-4-2">java library</a>. JavaInspect uses primarily Java built-in reflection to
 271 discover and visualize any part of Java program.
 272 </p>
 273
 274 <p>
 275 JavaInspect currently has no GUI, configuration files, embedded
 276 scripting support, direct Maven or Ant integration. See <a href="#sec-4">usage</a> to learn
 277 how to instuct Javainspect what to do.
 278 </p>
 279
 280 <p>
 281 After discovering application structure and optionally filtering out
 282 unimportant parts, JavaInspect produces GraphViz dot file that
 283 describes data to be visualized. Then launches GraphViz to generate
 284 bitmap graph in PNG or SVG format.
 285 </p>
 286
 287 <p>
 288 By default on your Desktop directory when operated in library mode or
 289 current working directory when operated as standalone commandline
 290 application.
 291 </p>
 292
 293 <p>
 294 Notes:
 295 </p>
 296 <ul class="org-ul">
 297 <li>JavaInspect is developed and tested so far only on GNU/Linux.
 298 </li>
 299 <li>See: <a href="https://github.com/pahen/madge">Madge - similar tool for JavaScript</a>
 300 </li>
 301 </ul>
 302 </div>
 303 </div>
 304
 305 <div id="outline-container-sec-3" class="outline-2">
 306 <h2 id="sec-3"><span class="section-number-2">3</span> Example graphs</h2>
 307 <div class="outline-text-2" id="text-3">
 308 <ul class="org-ul">
 309 <li>A very simple example:
 310
 311
 312 <figure>
 313 <p><img src="example.png" class="img-responsive" alt="example.png">
 314 </p>
 315 </figure>
 316
 317 <p>
 318 Graph legend:
 319 </p>
 320
 321
 322 <figure>
 323 <p><img src="legend.png" class="img-responsive" alt="legend.png">
 324 </p>
 325 </figure>
 326 </li>
 327 </ul>
 328
 329
 330 <ul class="org-ul">
 331 <li><a href="https://www3.svjatoslav.eu/projects/sixth-3d/graphs/">See example produced graphs</a> for <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D - 3D engine project</a>.
 332 </li>
 333 </ul>
 334 </div>
 335 </div>
 336
 337 <div id="outline-container-sec-4" class="outline-2">
 338 <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>
 339 <div class="outline-text-2" id="text-4">
 340 <p>
 341 JavaInspect can be controlled in 2 different ways:
 342 </p>
 343 <ul class="org-ul">
 344 <li><a href="#sec-4-1">as standalone commandline utility</a>
 345 </li>
 346 <li><a href="#sec-4-2">as embedded Java library via Java API</a>
 347 </li>
 348 </ul>
 349 </div>
 350
 351 <div id="outline-container-sec-4-1" class="outline-3">
 352 <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>
 353 <div class="outline-text-3" id="text-4-1">
 354 <p>
 355 To enable commandline support, (study and) execute script:
 356 </p>
 357 <pre class="example">
 358 commandline launcher/install
 359
 360 </pre>
 361
 362 <p>
 363 Warning: It was tested only on Debian Stretch linux.
 364 </p>
 365
 366 <p>
 367 Available commandline arguments:
 368 </p>
 369 <p class="verse">
 370 -j (existing files)&#x2026;<br >
 371 &#xa0;&#xa0;&#xa0;&#xa0;JAR file(s) to render.<br >
 372 <br >
 373 -n (mandatory, string)<br >
 374 &#xa0;&#xa0;&#xa0;&#xa0;Graph name.<br >
 375 <br >
 376 &#x2013;debug<br >
 377 &#xa0;&#xa0;&#xa0;&#xa0;Show debug info.<br >
 378 <br >
 379 -k<br >
 380 &#xa0;&#xa0;&#xa0;&#xa0;Keep dot file.<br >
 381 <br >
 382 -h<br >
 383 &#xa0;&#xa0;&#xa0;&#xa0;Hide orphaned classes.<br >
 384 <br >
 385 -w (one to many strings)&#x2026;<br >
 386 &#xa0;&#xa0;&#xa0;&#xa0;Whitelist glob(s).<br >
 387 <br >
 388 -b (one to many strings)&#x2026;<br >
 389 &#xa0;&#xa0;&#xa0;&#xa0;Blacklist glob(s).<br >
 390 <br >
 391 -d (existingdirectory)<br >
 392 &#xa0;&#xa0;&#xa0;&#xa0;Target directory. Default is current directory.<br >
 393 <br >
 394 -t (options: png, svg)<br >
 395 &#xa0;&#xa0;&#xa0;&#xa0;Target image type. Default is: svg.<br >
 396 </p>
 397 </div>
 398 </div>
 399 <div id="outline-container-sec-4-2" class="outline-3">
 400 <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>
 401 <div class="outline-text-3" id="text-4-2">
 402 <p>
 403 Requires that classes to be visualised are available in the classpath.
 404 </p>
 405
 406 <p>
 407 To get JavaInspect into same classpath with your projecs I so far came
 408 up with 2 solutions:
 409 </p>
 410
 411 <ol class="org-ol">
 412 <li>Add JavaInspect library in your project as a dependency.
 413 </li>
 414
 415 <li>Create new Java project for the purpose visualizing your other
 416 projects and include JavaInspect and your projecs binary artifacts
 417 (Jar's) into new project classpath. Built binary Jar's (with no
 418 source code) are sufficient because JavaInspect operates via
 419 reflection.
 420 </li>
 421 </ol>
 422
 423 <p>
 424 Simple Java based control/configuration code needs to be written for
 425 each project. I usually put such code into directories devoted for
 426 JUnit tests. Because it needs not to be compiled/embedded into final
 427 product or project artifact I'm just willing to visualize.
 428 </p>
 429
 430 <p>
 431 Control code in general does the following:
 432 </p>
 433 <ol class="org-ol">
 434 <li>Create graph object.
 435 </li>
 436 <li>Java reflection/classloaders does not provide mechanism for
 437 discovering all classes under given package. Therefore you need to
 438 declare at least some classes to be added to the graph by:
 439 <ul class="org-ul">
 440 <li>Manually adding individual classes to the graph.
 441 </li>
 442 <li>and/or: Let GraphViz recursively scan and parse specified
 443 directories with Java source code files to discover class names.
 444 </li>
 445 <li>For every class added to the graph, GraphViz will recursively
 446 inspect it and add all referecned classes to the graph as well.
 447 </li>
 448 </ul>
 449 </li>
 450 <li>Graphs easilly get very big and complex so optionally we filter
 451 important code using classname wildcards patterns based blacklist
 452 and/or whitelist.
 453 </li>
 454 <li>Optionally we can tune some rendering parameters like:
 455 <ul class="org-ul">
 456 <li>Possibility to remove orphaned classes (classes with no
 457 references) from the graph.
 458 </li>
 459 <li>Specify target directory for generated visualization
 460 files. (Default is user desktop directory)
 461 </li>
 462 <li>Keep intermediate GraphViz dot file for later inspection.
 463 </li>
 464 </ul>
 465 </li>
 466 <li>Render graph.
 467 </li>
 468 </ol>
 469 </div>
 470
 471
 472 <div id="outline-container-sec-4-2-1" class="outline-4">
 473 <h4 id="sec-4-2-1"><span class="section-number-4">4.2.1</span> example 1: individually picked objects</h4>
 474 <div class="outline-text-4" id="text-4-2-1">
 475 <p>
 476 This example demonstrates generating of class graph from hand picked
 477 classes and visualizing GraphViz itself.
 478 </p>
 479
 480 <div class="org-src-container">
 481
 482 <pre class="src src-java">
 483 // Create graph
 484 final ClassGraph graph = new ClassGraph();
 485
 486 // Add some random object to the graph. GraphViz will detect Class from
 487 // the object.
 488 graph.add(graph);
 489
 490 // Also add some random class to the graph.
 491 graph.add(Utils.class);
 492
 493 // Keep intermediary GraphViz DOT file for reference.
 494 graph.setKeepDotFile(true);
 495
 496 // Produce bitmap image titled "JavaInspect.png" to the user Desktop
 497 // directory
 498 graph.generateGraph("JavaInspect");
 499
 500 </pre>
 501 </div>
 502
 503 <p>
 504 Note: if desired, more compact version of the above:
 505 </p>
 506 <div class="org-src-container">
 507
 508 <pre class="src src-java">new ClassGraph().add(randomObject, RandomClass.class)
 509                 .setKeepDotFile(true).generateGraph("JavaInspect");
 510 </pre>
 511 </div>
 512
 513
 514 <p>
 515 Result:
 516 </p>
 517 <ul class="org-ul">
 518 <li>Generated DOT file: <a href="JavaInspect.dot">JavaInspect.dot</a>
 519 </li>
 520 <li>Generated PNG image: <a href="JavaInspect.png">JavaInspect.png</a>
 521 </li>
 522 </ul>
 523 </div>
 524 </div>
 525
 526 <div id="outline-container-sec-4-2-2" class="outline-4">
 527 <h4 id="sec-4-2-2"><span class="section-number-4">4.2.2</span> example 2: scan java code, apply filters</h4>
 528 <div class="outline-text-4" id="text-4-2-2">
 529 <div class="org-src-container">
 530
 531 <pre class="src src-java">// Create graph
 532 final ClassGraph graph = new ClassGraph();
 533
 534 // Recursively scan current directory for Java source code and attempt
 535 // to detect class names from there to be added to the graph.
 536 graph.addProject(".");
 537
 538 // Blacklist example classes from being shown on the graph
 539 graph.blacklistClassPattern("eu.svjatoslav.inspector.java.structure.example.*");
 540
 541 // do not show single classes with no relationships on the graph
 542 graph.hideOrphanedClasses();
 543
 544 // Produce bitmap image titled "JavaInspect full project.png" to the
 545 // user Desktop directory.
 546 graph.generateGraph("JavaInspect full project");
 547 </pre>
 548 </div>
 549 <p>
 550 Result:
 551 </p>
 552 <ul class="org-ul">
 553 <li>Generated PNG image: <a href="JavaInspect%20full%20project.png">JavaInspect full project.png</a>
 554 </li>
 555 </ul>
 556 </div>
 557 </div>
 558
 559 <div id="outline-container-sec-4-2-3" class="outline-4">
 560 <h4 id="sec-4-2-3"><span class="section-number-4">4.2.3</span> example 3: GraphViz embedded in another project</h4>
 561 <div class="outline-text-4" id="text-4-2-3">
 562 <ol class="org-ol">
 563 <li>Download project Sixth <a href="https://www2.svjatoslav.eu/gitweb/?p=sixth.git;a=snapshot;h=HEAD;sf=tgz">code snapshot</a>.
 564 </li>
 565 <li>Inspect and run *DataGraph.java*.
 566 </li>
 567 </ol>
 568 </div>
 569 </div>
 570
 571 <div id="outline-container-sec-4-2-4" class="outline-4">
 572 <h4 id="sec-4-2-4"><span class="section-number-4">4.2.4</span> Embedding JavaInspect in your Maven project</h4>
 573 <div class="outline-text-4" id="text-4-2-4">
 574 <p>
 575 Declare JavaInspect as dependency:
 576 </p>
 577 <div class="org-src-container">
 578
 579 <pre class="src src-xml">&lt;dependencies&gt;
 580     ...
 581     &lt;dependency&gt;
 582         &lt;groupId&gt;eu.svjatoslav&lt;/groupId&gt;
 583         &lt;artifactId&gt;javainspect&lt;/artifactId&gt;
 584         &lt;version&gt;1.6&lt;/version&gt;
 585     &lt;/dependency&gt;
 586     ...
 587 &lt;/dependencies&gt;
 588 </pre>
 589 </div>
 590
 591
 592 <p>
 593 Add Maven repository to retrieve artifact from:
 594 </p>
 595 <div class="org-src-container">
 596
 597 <pre class="src src-xml">&lt;repositories&gt;
 598     ...
 599     &lt;repository&gt;
 600         &lt;id&gt;svjatoslav.eu&lt;/id&gt;
 601         &lt;name&gt;Svjatoslav repository&lt;/name&gt;
 602         &lt;url&gt;http://www2.svjatoslav.eu/maven/&lt;/url&gt;
 603     &lt;/repository&gt;
 604     ...
 605 &lt;/repositories&gt;
 606 </pre>
 607 </div>
 608 </div>
 609 </div>
 610 </div>
 611 </div>
 612
 613 <div id="outline-container-sec-5" class="outline-2">
 614 <h2 id="sec-5"><span class="section-number-2">5</span> Requirements</h2>
 615 <div class="outline-text-2" id="text-5">
 616 <p>
 617 <a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on the computer.
 618 </p>
 619
 620 <p>
 621 On Ubuntu/Debian use:
 622 </p>
 623 <div class="org-src-container">
 624
 625 <pre class="src src-sh">sudo apt-get install graphviz
 626 </pre>
 627 </div>
 628 </div>
 629 </div>
 630 <div id="outline-container-sec-6" class="outline-2">
 631 <h2 id="sec-6"><span class="section-number-2">6</span> TO DO</h2>
 632 <div class="outline-text-2" id="text-6">
 633 <p>
 634 Note: Because this is side project (and I have many of them) I can
 635 only contribute few hours per year at average. Any help is welcome.  A
 636 LOT of cool ideas could be implemented. For intstance:
 637 </p>
 638
 639 <ul class="org-ul">
 640 <li>BUG: Should not hide references if there are too many of them to
 641 classes if referring classes are not visible anyway because of
 642 blacklist/whitelist rules. Basically reference counting should
 643 exclude not visible classes.
 644 </li>
 645
 646 <li>BUG: Orphaned class removal does not work always. There are many
 647 bugs and corner cases to find and fix still.
 648 </li>
 649
 650 <li>BUG: Code is not very readable. Document and refactor for better
 651 maintainability.
 652 </li>
 653
 654 <li>FEATURE: Create installable DEB package.
 655 <ul class="org-ul">
 656 <li>Submit it to some Debian developer for integration or become
 657 Debian package maintainer.
 658 </li>
 659 </ul>
 660 </li>
 661
 662 <li>FEATURE: Make it modular. That is: central part, an application
 663 model could be standalone and serializable.
 664
 665 <ul class="org-ul">
 666 <li>There could be multiple ways to acquire model:
 667 <ul class="org-ul">
 668 <li>By introspecting application via Java reflections (current mode
 669 of operation).
 670 </li>
 671 <li>By parsing java source. (unfinished)
 672 </li>
 673 </ul>
 674 </li>
 675
 676 <li>There could be ways to manipulate model:
 677 <ul class="org-ul">
 678 <li>Store/load/compare.
 679 </li>
 680 <li>Trim uninteresting parts.
 681 </li>
 682 <li>Highlight important parts.
 683 </li>
 684 </ul>
 685 </li>
 686
 687 <li>There could be multiple ways to render model:
 688 <ul class="org-ul">
 689 <li>PNG/SVG (currently implemented)
 690 </li>
 691 <li>PlantUML (TODO)
 692 </li>
 693 <li>Interactive 3D visualization (TODO)
 694 </li>
 695 </ul>
 696 </li>
 697 </ul>
 698 </li>
 699
 700 <li>FEATURE: Replace internal java parser in package
 701 eu.svjatoslav.inspector.java.methods with: <a href="https://javaparser.org/">https://javaparser.org/</a>
 702 </li>
 703
 704 <li>FEATURE: Integarte with <a href="http://plantuml.com/class-diagram">PlantUML</a>.
 705 </li>
 706
 707 <li>FEATURE: Add dark theme for generated graphs.
 708 </li>
 709
 710 <li>FEATURE: Sort Class fields by alphabet.
 711 </li>
 712
 713 <li>FEATURE: Visualize also concrete field values so it could be used as
 714 ultra cool runtime logging/debugging framework.
 715 </li>
 716
 717 <li>FEATURE: Possibility to visualize structure and data from JVM
 718 snapshot.
 719 </li>
 720
 721 <li>FEATURE: Possibility to attach to remote process to visualize
 722 data/structure using JVM debug port and mechanism.
 723 </li>
 724
 725 <li>FEATURE: Possibility to attach to JVM using JVM agent.
 726 </li>
 727
 728 <li>FEATURE: Possibility to inspect graphs in 3D using <a href="https://www3.svjatoslav.eu/projects/sixth-3d/">Sixth 3D engine</a>.
 729 </li>
 730
 731 <li>FEATURE: Possibility to select classes/fields/values to be
 732 visualized in some graph query language. For greater flexibility in
 733 comparison to currently supported glob syntax.
 734 </li>
 735
 736 <li>FEATURE: Add option to control JavaInspect via JSON or XML config
 737 file. For example different graphs for given project could be
 738 defined once in plain text config, possibly with the aid of some
 739 interactive utility. Then defined graphs could be updated as part of
 740 project build or release process.
 741 </li>
 742
 743 <li>FEATURE: Configurable maven plugin to generate graphs as part of the
 744 project build/release process.
 745 </li>
 746 </ul>
 747 </div>
 748 </div>
 749 </div><div class="col-md-3"><nav id="table-of-contents">
 750 <div id="text-table-of-contents" class="bs-docs-sidebar">
 751 <ul class="nav">
 752 <li><a href="#sec-1">1. General</a>
 753 <ul class="nav">
 754 <li><a href="#sec-1-1">1.1. Source code</a></li>
 755 </ul>
 756 </li>
 757 <li><a href="#sec-2">2. Goal and operating principle</a></li>
 758 <li><a href="#sec-3">3. Example graphs</a></li>
 759 <li><a href="#sec-4">4. Usage</a>
 760 <ul class="nav">
 761 <li><a href="#sec-4-1">4.1. usage as commandline utility</a></li>
 762 <li><a href="#sec-4-2">4.2. usage via Java API</a></li>
 763 </ul>
 764 </li>
 765 <li><a href="#sec-5">5. Requirements</a></li>
 766 <li><a href="#sec-6">6. TO DO</a></li>
 767 </ul>
 768 </div>
 769 </nav>
 770 </div></div></div>
 771 <footer id="postamble" class="">
 772 <div><p class="author">Author: Svjatoslav Agejenko</p>
 773 <p class="date">Created: 2019-01-19 Sat 00:47</p>
 774 <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>
 775 </div>
 776 </footer>
 777 </body>
 778 </html>