de.elnarion.util.plantuml.generator

Class PlantUMLClassDiagramGenerator

java.lang.Object

de.elnarion.util.plantuml.generator.PlantUMLClassDiagramGenerator

public class PlantUMLClassDiagramGenerator
extends Object

This class provides the ability to generate a PlantUML class diagram out of a list of package names. Therefore this class scans directories and jars for all classes contained directly in these packages and generates a class diagram out of them via reflection To be able to get the right classes you have to provide the necessary ClassLoader, which is able to load these classes. Currently this generator supports the following class types:

• class
• abstract class
• annotation
• enum
• interface

with some restrictions: The type annotation does not contain any further information than its name and no Annotation relationships are included in the diagram. The type enum contains only the constants. All other types contain field and method informations. Relationships are included for

• inheritance
• realization
• aggregation (only for List and Set types)
• usage (only direct usage via field)

You can hide all fields via hideFields parameter or you can hide all methods via hideMethods parameter. If you want to hide a list of classes you have to provide a String List with full qualified class names.

Constructor Summary

Constructors

Constructor and Description
PlantUMLClassDiagramGenerator(ClassLoader paramClassloader, List<String> paramScanPackages, String paramBlacklistRegexp, List<String> paramHideClasses, boolean paramHideFields, boolean paramHideMethods) Instantiates a new Plant UML diagram generator.
PlantUMLClassDiagramGenerator(ClassLoader paramClassloader, String paramWhitelistRegexp, List<String> paramHideClasses, boolean paramHideFields, boolean paramHideMethods, List<String> paramScanPackages) Instantiates a new plant UML class diagram generator.
PlantUMLClassDiagramGenerator(PlantUMLConfig paramPlantUMLConfig)

Method Summary

Modifier and Type	Method and Description
String	generateDiagramText() Generate the class diagram string for all classes in the configured packages.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PlantUMLClassDiagramGenerator

public PlantUMLClassDiagramGenerator(ClassLoader paramClassloader,
                                     List<String> paramScanPackages,
                                     String paramBlacklistRegexp,
                                     List<String> paramHideClasses,
                                     boolean paramHideFields,
                                     boolean paramHideMethods)

Instantiates a new Plant UML diagram generator.

Parameters:

paramClassloader - ClassLoader - the ClassLoader used for loading all diagram classes

paramScanPackages - List<String> - all the packages which directly contained classes are the base for the class diagram

paramBlacklistRegexp - String - regular expression used to reduce the amount of classes defined by the packages to scan

paramHideClasses - List<String> - the full qualified class names which should be hidden in the resulting diagram (they are not excluded from the diagram, they are just hidden)

paramHideFields - boolean - true, if fields should be hidden, false, if not

paramHideMethods - boolean - true, if methods should be hidden, false, if not

PlantUMLClassDiagramGenerator

public PlantUMLClassDiagramGenerator(ClassLoader paramClassloader,
                                     String paramWhitelistRegexp,
                                     List<String> paramHideClasses,
                                     boolean paramHideFields,
                                     boolean paramHideMethods,
                                     List<String> paramScanPackages)

Instantiates a new plant UML class diagram generator.

Parameters:

paramClassloader - ClassLoader - the ClassLoader used for loading all diagram classes

paramWhitelistRegexp - Regular expression used to define all classes which should be part of the diagram (alternative to scan packages definition)

paramHideClasses - List<String> - the full qualified class names which should be hidden in the resulting diagram (they are not excluded from the diagram, they are just hidden)

paramHideFields - boolean - true, if fields should be hidden, false, if not

paramHideMethods - boolean - true, if methods should be hidden, false, if not

paramScanPackages - List<String> - all the packages which should be used as basis for the whitelist scan

PlantUMLClassDiagramGenerator

public PlantUMLClassDiagramGenerator(PlantUMLConfig paramPlantUMLConfig)

Method Detail

generateDiagramText

public String generateDiagramText()
                           throws ClassNotFoundException,
                                  IOException

Generate the class diagram string for all classes in the configured packages.

Returns:

String - the text containing all Plant UML class diagram definitions

Throws:

IOException - - thrown if a class or jar File could not be read

ClassNotFoundException - - thrown if a class in a package could not be found or if a package does not contain any class information