This example demonstrates generating of class graph from hand picked -classes. +classes and visualizing GraphViz itself.
// Create graph final ClassGraph graph = new ClassGraph(); -// While classes and objects can be immediately passed to ClassGraph -// constructor as arguments, it is also possible to add them one by -// one as in the following example. +// Add some random object to the graph. GraphViz will detect Class from +// the object. +graph.add(graph); -// Add some object to the graph. -graph.addObject(graph); +// Also add some random class to the graph. +graph.add(Utils.class); -// Add some class to the graph. -graph.addClass(Utils.class); +// Keep intermediary GraphViz DOT file for reference. +graph.setKeepDotFile(true); // Produce bitmap image titled "JavaInspect.png" to the user Desktop -// directory and keep intermediary GraphViz DOT file for reference. -graph.generateGraph("JavaInspect", true); +// directory +graph.generateGraph("JavaInspect");
+Note: if desired, more compact version of the above: +
+new ClassGraph().add(randomObject, RandomClass.class) + .setKeepDotFile(true).generateGraph("JavaInspect"); ++
@@ -357,20 +366,19 @@ Result:
-Recursively scan current directory for Java source code and attempt to -detect class names from there to be added to the graph. -
-graph.addProject("."); +// 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.getFilter().blacklistClassPattern( - "eu.svjatoslav.inspector.java.structure.example.*"); +graph.blacklistClassPattern("eu.svjatoslav.inspector.java.structure.example.*"); // do not show single classes with no relationships on the graph graph.hideOrphanedClasses(); @@ -404,7 +412,7 @@ Declare JavaInspect as dependency: <dependency> <groupId>eu.svjatoslav</groupId> <artifactId>javainspect</artifactId> - <version>1.3</version> + <version>1.5-SNAPSHOT</version> </dependency> ... </dependencies> @@ -441,11 +449,13 @@ Add Maven repository to retrieve artifact from:On Ubuntu/Debian use:
--sudo apt-get install graphviz ++ +sudo apt-get install graphviz