+ /*
+ * This example demonstrates generating of class graph from hand picked
+ * classes.
+ */
-
+ // Create graph
+ final ClassGraph graph = new ClassGraph();
-
-// 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 then one by one
+ // as in the following example.
-// Add some object to the graph.
-graph.addObject(graph);
+ // Add some object to the graph.
+ graph.addObject(graph);
-// Add some class to the graph.
-graph.addClass(Utils.class);
+ // Add some class to the graph.
+ graph.addClass(Utils.class);
-// Produce bitmap image titled "JavaInspect.png" to the user Desktop
-// directory.
-graph.generateGraph("JavaInspect", true);
+ // Produce bitmap image titled "JavaInspect.png" to the user Desktop
+ // directory and keep intermediary GraphViz DOT file for reference.
+ graph.generateGraph("JavaInspect", true);
@@ -99,6 +104,33 @@ Result:
+ Usage example 2
+
+
+
+ // 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.*");
+
+ // 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");
+
+
+
+Result:
+ Generated PNG image: JavaInspect full project.png
+
+
+
+
Embedding JavaInspect in your project
@@ -112,7 +144,7 @@ Declare JavaInspect as dependency:
<dependency>
<groupId>eu.svjatoslav</groupId>
<artifactId>javainspect</artifactId>
- <version>1.1</version>
+ <version>1.3</version>
</dependency>
</dependencies>
