org.umlgraph.doclet
Class UmlGraph

Show UML class diagram
java.lang.Object
  extended by org.umlgraph.doclet.UmlGraph

public class UmlGraph
extends Object

Doclet API implementation


Field Summary
private static Options commentOptions
          Options used for commenting nodes
private static String docletName
           
private static String programName
           
 
Constructor Summary
UmlGraph()
           
 
Method Summary
static void buildGraph(RootDoc root, OptionProvider op, Doc contextDoc)
          Builds and outputs a single graph according to the view overrides
static Options buildOptions(RootDoc root)
          Creates the base Options object.
private static View buildView(RootDoc root, ClassDoc viewClass, OptionProvider provider)
          Builds a view along with its parent views, recursively
static View[] buildViews(Options opt, RootDoc srcRootDoc, RootDoc viewRootDoc)
          Builds the views according to the parameters on the command line
private static ClassDoc findClass(RootDoc root, String name)
          Return the ClassDoc for the specified class; null if not found.
static Options getCommentOptions()
           
static LanguageVersion languageVersion()
          Indicate the language version we support
static void main(String[] args)
           
static int optionLength(String option)
          Option checking
static boolean start(RootDoc root)
          Entry point through javadoc
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

programName

private static final String programName
See Also:
Constant Field Values

docletName

private static final String docletName
See Also:
Constant Field Values

commentOptions

private static Options commentOptions
Options used for commenting nodes

Constructor Detail

UmlGraph

public UmlGraph()
Method Detail

start

public static boolean start(RootDoc root)
                     throws IOException
Entry point through javadoc

Throws:
IOException

main

public static void main(String[] args)

getCommentOptions

public static Options getCommentOptions()

buildOptions

public static Options buildOptions(RootDoc root)
Creates the base Options object. This contains both the options specified on the command line and the ones specified in the UMLOptions class, if available. Also create the globally accessible commentOptions object.


findClass

private static ClassDoc findClass(RootDoc root,
                                  String name)
Return the ClassDoc for the specified class; null if not found.


buildGraph

public static void buildGraph(RootDoc root,
                              OptionProvider op,
                              Doc contextDoc)
                       throws IOException
Builds and outputs a single graph according to the view overrides

Throws:
IOException

buildViews

public static View[] buildViews(Options opt,
                                RootDoc srcRootDoc,
                                RootDoc viewRootDoc)
Builds the views according to the parameters on the command line

Parameters:
opt - The options
srcRootDoc - The RootDoc for the source classes
viewRootDoc - The RootDoc for the view classes (may be different, or may be the same as the srcRootDoc)

buildView

private static View buildView(RootDoc root,
                              ClassDoc viewClass,
                              OptionProvider provider)
Builds a view along with its parent views, recursively


optionLength

public static int optionLength(String option)
Option checking


languageVersion

public static LanguageVersion languageVersion()
Indicate the language version we support