Code refactoring. Simplified API.

[javainspect.git] / src / main / java / eu / svjatoslav / inspector / java / structure / ClassGraph.java

diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
index 31ddbed..27eff03 100755 (executable)
--- a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
+++ b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java
@@ -1,7 +1,7 @@
 /*
  * JavaInspect - Utility to visualize java software
- * Copyright (C) 2013-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
- * 
+ * Copyright (C) 2013-2015, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu
+ *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of version 3 of the GNU Lesser General Public License
  * or later as published by the Free Software Foundation.
@@ -21,63 +21,34 @@ import eu.svjatoslav.inspector.java.methods.ProjectScanner;
 
 public class ClassGraph {
 
-       public static void render(final String graphName, final Class... classes) {
-               final ClassGraph classGraph = new ClassGraph(classes);
-
-               classGraph.generateGraph(graphName);
-       }
-
        /**
         * Maps class fully qualified names to class descriptors.
         */
-       Map<String, ClassDescriptor> nameToClassMap = new HashMap<String, ClassDescriptor>();
+       private final Map<String, ClassDescriptor> fullyQualifiedNameToClassMap = new HashMap<String, ClassDescriptor>();
 
-       private Filter filter = new Filter();
+       private final Filter filter = new Filter();
 
        public ClassGraph() {
        }
 
-       /**
-        * @param classes
-        *            classes that shall be added to graph
-        */
-       public ClassGraph(final Class<? extends Object>... classes) {
-               for (final Class<? extends Object> clazz : classes)
-                       addClass(clazz);
-       }
-
        /**
         * @param objects
         *            objects that shall be added to graph
         */
-       public ClassGraph(final Object... objects) {
-               for (final Object object : objects)
-                       addClass(object.getClass());
-       }
+       public ClassGraph add(final Object... objects) {
 
-       /**
-        * @param clazz
-        *            class that shall be added to graph
-        */
-       public ClassDescriptor addClass(final Class<? extends Object> clazz) {
+               if (objects != null)
+                       for (final Object object : objects)
+                               addObject(object);
 
-               if (clazz == null)
-                       return null;
-
-               final String className = clazz.getName();
-
-               if (nameToClassMap.containsKey(className))
-                       return nameToClassMap.get(className);
-
-               return new ClassDescriptor(clazz, this);
+               return this;
        }
 
-       /**
-        * @param object
-        *            object that shall be added to graph
-        */
-       public ClassDescriptor addObject(final Object object) {
-               return addClass(object.getClass());
+       private void addObject(final Object object) {
+               if (object instanceof Class)
+                       getOrCreateClassDescriptor((Class) object);
+               else
+                       getOrCreateClassDescriptor(object.getClass());
        }
 
        /**
@@ -91,7 +62,7 @@ public class ClassGraph {
                        try {
                                System.out.println("Class full name: " + clazz.getFullName());
                                final Class c = this.getClass().forName(clazz.getFullName());
-                               addClass(c);
+                               addObject(c);
                        } catch (final Exception exception) {
                                System.out.println("cannot add class: "
                                                + exception.getMessage());
@@ -112,7 +83,7 @@ public class ClassGraph {
         *            file name for the generated graph. File extension will be
         *            added automatically. Existing file with the same name will be
         *            overwritten.
-        * 
+        *
         * @param keepDotFile
         *            if set to <code>true</code> then intermediary GraphViz DOT
         *            file will be kept.
@@ -124,8 +95,31 @@ public class ClassGraph {
                final String desktopPath = CommonPathResolver.getDesktopDirectory()
                                .getAbsolutePath() + "/";
 
-               final String dotFilePath = desktopPath + resultFileName + ".dot";
-               final String imageFilePath = desktopPath + resultFileName + ".png";
+               generateGraph(desktopPath, resultFileName, keepDotFile);
+       }
+
+       /**
+        * @param targetDirectory
+        *            target directory name
+        *
+        * @param resultFileName
+        *            file name for the generated graph. File extension will be
+        *            added automatically. Existing file with the same name will be
+        *            overwritten.
+        *
+        * @param keepDotFile
+        *            if set to <code>true</code> then intermediary GraphViz DOT
+        *            file will be kept.
+        */
+
+       public void generateGraph(String targetDirectory,
+                       final String resultFileName, final boolean keepDotFile) {
+
+               if (!targetDirectory.endsWith("/"))
+                       targetDirectory += "/";
+
+               final String dotFilePath = targetDirectory + resultFileName + ".dot";
+               final String imageFilePath = targetDirectory + resultFileName + ".png";
 
                System.out.println("Dot file path:" + dotFilePath);
 
@@ -152,6 +146,7 @@ public class ClassGraph {
                } catch (final IOException e) {
                        System.err.println(e);
                }
+
        }
 
        private String getDot() {
@@ -160,7 +155,7 @@ public class ClassGraph {
                result.append("digraph Java {\n");
                result.append("graph [rankdir=LR, overlap = false, concentrate=true];\n");
 
-               for (final Map.Entry<String, ClassDescriptor> entry : nameToClassMap
+               for (final Map.Entry<String, ClassDescriptor> entry : fullyQualifiedNameToClassMap
                                .entrySet())
                        result.append(entry.getValue().getDot());
 
@@ -174,18 +169,40 @@ public class ClassGraph {
                return filter;
        }
 
+       /**
+        * @param clazz
+        *            class that shall be added to graph
+        */
+       protected ClassDescriptor getOrCreateClassDescriptor(final Class clazz) {
+
+               if (clazz == null)
+                       return null;
+
+               final String classFullyQualifiedName = clazz.getName();
+
+               // reuse existing instance if possible
+               if (fullyQualifiedNameToClassMap.containsKey(classFullyQualifiedName))
+                       return fullyQualifiedNameToClassMap.get(classFullyQualifiedName);
+
+               // create new class descriptor
+               final ClassDescriptor newClassDescriptor = new ClassDescriptor(this);
+               fullyQualifiedNameToClassMap.put(classFullyQualifiedName,
+                               newClassDescriptor);
+
+               newClassDescriptor.analyzeClass(clazz);
+
+               return newClassDescriptor;
+       }
+
        /**
         * Hide orphaned class that have no references
         */
        public void hideOrphanedClasses() {
 
-               for (final ClassDescriptor classDescriptor : nameToClassMap.values())
+               for (final ClassDescriptor classDescriptor : fullyQualifiedNameToClassMap
+                               .values())
                        classDescriptor.hideClassIfNoReferences();
 
        }
 
-       public void setFilter(final Filter filter) {
-               this.filter = filter;
-       }
-
 }