org.umlgraph.doclet

Class UmlGraphDoc

Show UML class diagram

java.lang.Object

org.umlgraph.doclet.UmlGraphDoc

public class UmlGraphDoc
extends Object

Chaining doclet that runs the standart Javadoc doclet first, and on success, runs the generation of dot files by UMLGraph

Field Summary

Fields

Modifier and Type	Field and Description
private static String	EXPANDABLE_UML
private static String	EXPANDABLE_UML_STYLE
private static String	UML_AUTO_SIZED_DIV_TAG
private static String	UML_DIV_TAG

Constructor Summary

Constructors

Constructor and Description
UmlGraphDoc()

Method Summary

Modifier and Type	Method and Description
private static void	alterHtmlDocs(Options opt, String outputFolder, String packageName, String className, String htmlFileName, Pattern insertPointPattern, RootDoc root) Takes an HTML file, looks for the first instance of the specified insertion point, and inserts the diagram image reference and a client side map in that point.
private static String	findOutputPath(String[][] options) Returns the output path specified on the javadoc options
private static void	generateContextDiagrams(RootDoc root, Options opt, String outputFolder) Generates the context diagram for a single class
private static void	generatePackageDiagrams(RootDoc root, Options opt, String outputFolder) Generates the package diagrams for all of the packages that contain classes among those returned by RootDoc.class()
static LanguageVersion	languageVersion() Standand doclet entry
static int	optionLength(String option) Option check, forwards options to the standard doclet, if that one refuses them, they are sent to UmlGraph
private static void	runGraphviz(String dotExecutable, String outputFolder, String packageName, String name, RootDoc root) Runs Graphviz dot building both a diagram (in png format) and a client side map for it.
static boolean	start(RootDoc root) Standard doclet entry point

Methods inherited from class java.lang.Object

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

Field Detail

UML_DIV_TAG

private static final String UML_DIV_TAG

See Also:

Constant Field Values

UML_AUTO_SIZED_DIV_TAG

private static final String UML_AUTO_SIZED_DIV_TAG

See Also:

Constant Field Values

EXPANDABLE_UML_STYLE

private static final String EXPANDABLE_UML_STYLE

See Also:

Constant Field Values

EXPANDABLE_UML

private static final String EXPANDABLE_UML

See Also:

Constant Field Values

Constructor Detail

UmlGraphDoc

public UmlGraphDoc()

Method Detail

optionLength

public static int optionLength(String option)

Option check, forwards options to the standard doclet, if that one refuses them, they are sent to UmlGraph

start

public static boolean start(RootDoc root)

Standard doclet entry point

Parameters:

root -

Returns:

languageVersion

public static LanguageVersion languageVersion()

Standand doclet entry

Returns:

generatePackageDiagrams

private static void generatePackageDiagrams(RootDoc root,
                                            Options opt,
                                            String outputFolder)
                                     throws IOException

Generates the package diagrams for all of the packages that contain classes among those returned by RootDoc.class()

Throws:

IOException

generateContextDiagrams

private static void generateContextDiagrams(RootDoc root,
                                            Options opt,
                                            String outputFolder)
                                     throws IOException

Generates the context diagram for a single class

Throws:

IOException

runGraphviz

private static void runGraphviz(String dotExecutable,
                                String outputFolder,
                                String packageName,
                                String name,
                                RootDoc root)

Runs Graphviz dot building both a diagram (in png format) and a client side map for it.

alterHtmlDocs

private static void alterHtmlDocs(Options opt,
                                  String outputFolder,
                                  String packageName,
                                  String className,
                                  String htmlFileName,
                                  Pattern insertPointPattern,
                                  RootDoc root)
                           throws IOException

Takes an HTML file, looks for the first instance of the specified insertion point, and inserts the diagram image reference and a client side map in that point.

Throws:

IOException

findOutputPath

private static String findOutputPath(String[][] options)

Returns the output path specified on the javadoc options