X-Git-Url: http://www2.svjatoslav.eu/gitweb/?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Feu%2Fsvjatoslav%2Finspector%2Fjava%2Fstructure%2FClassGraph.java;h=31ddbede42d3749cb8a8a538a958993017134e78;hb=31e8e0b97c9f60f8820d708fa86c11d65f5445f3;hp=4c1dcbca7d1f9cb7998b456beacd52f77f0e4cdb;hpb=5f9dd91cd9ee7069981879df7bb31c2e9617a5f3;p=javainspect.git diff --git a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java old mode 100644 new mode 100755 index 4c1dcbc..31ddbed --- a/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java +++ b/src/main/java/eu/svjatoslav/inspector/java/structure/ClassGraph.java @@ -1,10 +1,10 @@ /* * JavaInspect - Utility to visualize java software - * Copyright (C) 2013, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu + * Copyright (C) 2013-2014, Svjatoslav Agejenko, svjatoslav@svjatoslav.eu * * This program is free software; you can redistribute it and/or - * modify it under the terms of version 2 of the GNU General Public License - * as published by the Free Software Foundation. + * modify it under the terms of version 3 of the GNU Lesser General Public License + * or later as published by the Free Software Foundation. */ package eu.svjatoslav.inspector.java.structure; @@ -21,24 +21,44 @@ 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 nameToClassMap = new HashMap(); - public Filter filter = new Filter(); + private Filter filter = new Filter(); public ClassGraph() { } - public ClassGraph(final Class clazz) { - addClass(clazz); + /** + * @param classes + * classes that shall be added to graph + */ + public ClassGraph(final Class... classes) { + for (final Class clazz : classes) + addClass(clazz); } - public ClassGraph(final Object root) { - addClass(root.getClass()); + /** + * @param objects + * objects that shall be added to graph + */ + public ClassGraph(final Object... objects) { + for (final Object object : objects) + addClass(object.getClass()); } + /** + * @param clazz + * class that shall be added to graph + */ public ClassDescriptor addClass(final Class clazz) { if (clazz == null) @@ -52,10 +72,19 @@ public class ClassGraph { return new ClassDescriptor(clazz, this); } + /** + * @param object + * object that shall be added to graph + */ public ClassDescriptor addObject(final Object object) { return addClass(object.getClass()); } + /** + * @param path + * path to recursively scan for java source code could be + * relative to current project or absolute + */ public void addProject(final String path) { final ProjectScanner projectScanner = new ProjectScanner(new File(path)); for (final Clazz clazz : projectScanner.getAllClasses()) @@ -69,17 +98,34 @@ public class ClassGraph { } } - public void generateGraph(final String graphName) { - generateGraph(graphName, false); + /** + * @param resultFileName + * file name for the generated graph. Existing file with the same + * name will be overwritten. + */ + public void generateGraph(final String resultFileName) { + generateGraph(resultFileName, false); } - public void generateGraph(final String graphName, final boolean keepDotFile) { + /** + * @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 true then intermediary GraphViz DOT + * file will be kept. + */ + + public void generateGraph(final String resultFileName, + final boolean keepDotFile) { final String desktopPath = CommonPathResolver.getDesktopDirectory() .getAbsolutePath() + "/"; - final String dotFilePath = desktopPath + graphName + ".dot"; - final String imageFilePath = desktopPath + graphName + ".png"; + final String dotFilePath = desktopPath + resultFileName + ".dot"; + final String imageFilePath = desktopPath + resultFileName + ".png"; System.out.println("Dot file path:" + dotFilePath); @@ -124,4 +170,22 @@ public class ClassGraph { return resultStr; } + public Filter getFilter() { + return filter; + } + + /** + * Hide orphaned class that have no references + */ + public void hideOrphanedClasses() { + + for (final ClassDescriptor classDescriptor : nameToClassMap.values()) + classDescriptor.hideClassIfNoReferences(); + + } + + public void setFilter(final Filter filter) { + this.filter = filter; + } + }