org.beigesoft.uml.service.swing

Class CreatorDoclet

java.lang.Object

org.beigesoft.uml.service.swing.CreatorDoclet

public class CreatorDoclet
extends Object

Overriding standard Doclet with additional UML class diagrams

Author:

Yury Demidenko

Field Summary

Fields

Modifier and Type	Field and Description
static String	OPTION_PATH_UML_PROJECT
protected static org.apache.commons.io.nonstatic.SrvFile	srvFile

Constructor Summary

Constructors

Constructor and Description
CreatorDoclet()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	addRelatedClass(ClassFull<ClassUml> mainAsmClassUml, com.sun.javadoc.ClassDoc relatedClassDoc, ERelationshipKind relationKind, boolean isMainClassEnd)
protected static void	alterHtmlForClass(com.sun.javadoc.ClassDoc classDoc, com.sun.javadoc.RootDoc root)
protected static void	fillSubclasses(ClassFull<ClassUml> mainClass, com.sun.javadoc.ClassDoc classDoc, com.sun.javadoc.RootDoc root)
protected static void	fillUmlClass(com.sun.javadoc.ClassDoc classDoc, ClassFull<ClassUml> classUml)
protected static void	generateUml(com.sun.javadoc.RootDoc root)
static GuiMainUmlUninteractive	getMainGui()
static String	getPathJavaDoc()
static String	getPathMavenProject()
static String	getPathUmlProject()
static ProjectUml	getUmlProject()
protected static void	insertUmlDiagramMap(BufferedWriter writerAltered, File umlDiagramMapFile)
static com.sun.javadoc.LanguageVersion	languageVersion() Standard doclet method must be present to support generics!
protected static void	openOrCreateUmlProject(com.sun.javadoc.RootDoc root)
static int	optionLength(String option) Standard doclet method must be present!
protected static void	setOptions(com.sun.javadoc.RootDoc root)
static boolean	start(com.sun.javadoc.RootDoc root) Standard doclet start method
protected static String	toGoodTypeName(String typeName) e.g.

Methods inherited from class java.lang.Object

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

Field Detail

OPTION_PATH_UML_PROJECT

public static final String OPTION_PATH_UML_PROJECT

See Also:

Constant Field Values

srvFile

protected static final org.apache.commons.io.nonstatic.SrvFile srvFile

Constructor Detail

CreatorDoclet

public CreatorDoclet()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)
                     throws Exception

Standard doclet start method

Parameters:

root -

Returns:

Throws:

Exception

optionLength

public static int optionLength(String option)

Standard doclet method must be present!

Parameters:

option -

Returns:

languageVersion

public static com.sun.javadoc.LanguageVersion languageVersion()

Standard doclet method must be present to support generics!

Returns:

generateUml

protected static void generateUml(com.sun.javadoc.RootDoc root)
                           throws Exception

Throws:

Exception

alterHtmlForClass

protected static void alterHtmlForClass(com.sun.javadoc.ClassDoc classDoc,
                     com.sun.javadoc.RootDoc root)
                                 throws Exception

Throws:

Exception

insertUmlDiagramMap

protected static void insertUmlDiagramMap(BufferedWriter writerAltered,
                       File umlDiagramMapFile)
                                   throws Exception

Throws:

Exception

fillSubclasses

protected static void fillSubclasses(ClassFull<ClassUml> mainClass,
                  com.sun.javadoc.ClassDoc classDoc,
                  com.sun.javadoc.RootDoc root)

addRelatedClass

protected static void addRelatedClass(ClassFull<ClassUml> mainAsmClassUml,
                   com.sun.javadoc.ClassDoc relatedClassDoc,
                   ERelationshipKind relationKind,
                   boolean isMainClassEnd)

fillUmlClass

protected static void fillUmlClass(com.sun.javadoc.ClassDoc classDoc,
                ClassFull<ClassUml> classUml)

toGoodTypeName

protected static String toGoodTypeName(String typeName)

e.g. to convert java.lang.String[] to String[]

Parameters:

typeName -

Returns:

openOrCreateUmlProject

protected static void openOrCreateUmlProject(com.sun.javadoc.RootDoc root)
                                      throws Exception

Throws:

Exception

setOptions

protected static void setOptions(com.sun.javadoc.RootDoc root)
                          throws Exception

Throws:

Exception

getPathUmlProject

public static String getPathUmlProject()

getPathMavenProject

public static String getPathMavenProject()

getPathJavaDoc

public static String getPathJavaDoc()

getUmlProject

public static ProjectUml getUmlProject()

getMainGui

public static GuiMainUmlUninteractive getMainGui()