@@ -280,16 +280,10 @@ how to instuct Javainspect what to do.
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
+describes data to be visualized. Then launches GraphViz to generate
bitmap graph in PNG or SVG format.
-
-By default on your Desktop directory when operated in library mode or
-current working directory when operated as standalone commandline
-application.
-
@@ -430,21 +429,14 @@ Control code in general does the following:
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:
-
-
Manually adding individual classes to the graph.
-
-
and/or: Let GraphViz recursively scan and parse specified
-directories with Java source code files to discover class names.
-
-
For every class added to the graph, GraphViz will recursively
-inspect it and add all referecned classes to the graph as well.
-
-
+declare at least some classes to be added to the graph by manually
+adding individual classes to the graph. For every class added to
+the graph, GraphViz will recursively inspect it and add all
+referecned classes to the graph as well.
Graphs easilly get very big and complex so optionally we filter
-important code using classname wildcards patterns based blacklist
-and/or whitelist.
+important code using classname glob patterns based blacklist and/or
+whitelist.
Optionally we can tune some rendering parameters like:
@@ -452,7 +444,7 @@ and/or whitelist.
references) from the graph.
Specify target directory for generated visualization
-files. (Default is user desktop directory)
+files. (Default is current directory)
Keep intermediate GraphViz dot file for later inspection.
@@ -474,23 +466,22 @@ classes and visualizing GraphViz itself.
-
-// Create graph
-final ClassGraph graph = new ClassGraph();
+
// Create graph
+finalClassGraphgraph = newClassGraph();
-// Add some random object to the graph. GraphViz will detect Class from
-// the object.
+// 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);
+// Also add some random class to the graph.
+graph.add(Utils.class);
-// Keep intermediary GraphViz DOT file for reference.
-graph.setKeepDotFile(true);
+// Keep intermediary GraphViz DOT file for reference.
+graph.setKeepDotFile(true);
-// Produce bitmap image titled "JavaInspect.png" to the user Desktop
-// directory
-graph.generateGraph("JavaInspect");
+// Produce bitmap image titled "JavaInspect.png" to the user Desktop
+// directory
+graph.generateGraph("JavaInspect");
@@ -500,8 +491,8 @@ Note: if desired, more compact version of the above:
-
new ClassGraph().add(randomObject, RandomClass.class)
- .setKeepDotFile(true).generateGraph("JavaInspect");
+
4.2.2 example 2: GraphViz embedded in another project
-
-
-
// 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");
-
FEATURE: Implement (or integrate existing java parser
+https://javaparser.org/) to be able to produce code visualizations
+based on source code (in addition to current reflection based
+approach).
FEATURE: Integarte with PlantUML.
@@ -720,7 +680,7 @@ data/structure using JVM debug port and mechanism.
FEATURE: Possibility to attach to JVM using JVM agent.
-
FEATURE: Possibility to inspect graphs in 3D using Sixth 3D engine.
+
FEATURE: Possibility to inspect graphs in 3D using Sixth 3D engine.
FEATURE: Possibility to select classes/fields/values to be
@@ -741,6 +701,18 @@ project build/release process.
