<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
+ <h1>JavaInspect - Utility to visualize java software</h1>\r
+ href="http://www2.svjatoslav.eu/gitweb/?p=javainspect.git;a=snapshot;h=HEAD;sf=tgz">Download</a>\r
+ \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
<b>Program author:</b>\r
Svjatoslav Agejenko\r
Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>\r
\r
</pre>\r
\r
- <h2>General</h2>\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
+ Goal: simplify/speed up understanding the computer program code by\r
+ automatically visualizing its structure.\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
+ <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
- <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
+ <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
- <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
+ <h2>Example graphs</h2>\r
\r
- <br />\r
- <br /> A very simple example:\r
- <br />\r
- <a href="example.png"><img src="example.resized.png" /></a>\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/projects/sixth/codegraphs/">architecture\r
+ graphs</a>\r
\r
- <br /> Graph legend:\r
- <br />\r
- <img src="legend.png" />\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
- <h2>Usage example 1</h2>\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
+ * This example demonstrates generating of class graph from hand picked\r
+ * classes.\r
+ */\r
\r
- // Create graph\r
- final ClassGraph graph = new ClassGraph();\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
+ // 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
+ // Add some object to the graph.\r
+ graph.addObject(graph);\r
\r
- // Add some class to the graph.\r
- graph.addClass(Utils.class);\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
+ // 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
</pre>\r
\r
\r
- <h2>Usage example 2</h2>\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
+ // 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
+ // 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
+ // 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
+ // 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
\r
\r
\r
- <h2>Embedding JavaInspect in your project</h2>\r
- <pre>\r
+ <h2>Embedding JavaInspect in your project</h2>\r
\r
Declare JavaInspect as dependency:\r
\r
<artifactId>javainspect</artifactId>\r
<version>1.3</version>\r
</dependency>\r
- \r
+\r
</dependencies>\r
- \r
- \r
- \r
+\r
+\r
+\r
Add Maven repository to retrieve artifact from:\r
- \r
+\r
<repositories>\r
<repository>\r
<id>svjatoslav.eu</id>\r
\r
\r
\r
- <h2>Requirements</h2>\r
+ <h2>Requirements</h2>\r
\r
- <br>\r
- <a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on\r
- the computer.\r
+ <br>\r
+
<a href="http://www.graphviz.org/">GraphViz</a> - shall be installed on
\r+ the computer.\r
\r
\r
</body>\r
projects / javainspect.git / commitdiff