net.mdatools.modelant.uml13.reverse

Class ReverseEngineerJavaDoclet

java.lang.Object

com.sun.javadoc.Doclet

net.mdatools.modelant.uml13.reverse.ReverseEngineerJavaDoclet

public class ReverseEngineerJavaDoclet
extends com.sun.javadoc.Doclet

Javadoc - to - UML reverse engineering. It implements a standard Doclet functionality, uses the static resources of the outer class (as parameters) and generates UML classes for the java classes (and interfaces) reviewed.

The model created presents correctly the real packages, classes, interfaces, methods and attributes:

• Nested classes and interfaces are presented as well, though ones that are marked as static in Java are not marked as static in the model.
• The methods created are not bound to the exceptions they throw (due to some compatibility issues with Rose XML Plugin), though the exceptions and the stereotypes are registered in the model.
• The classes that are not included for documenting but are still referenced by ones being documented are included in the model as data types with the qualified class name. They are placed in the top-most package - the model itself.
• Only one-way X-to-many associations are identified and created. The two-way associations (navigable in both directions) are not identified.

Expected to find system properties:

• model - the name of the model to generate
• targetDir - the absolute path to the directory where to create the result file
• target - file name where to store the model. Assumed to be created in targetDir
• workDir - (optional) the absolute path to the directory where to create the temporary files

Author:

Rusi Popov (popovr@mdatools.net)

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAMETER_MODEL Doclet command-line parameter with the name of the model to construct
static String	PARAMETER_TARGET_FILE Doclet command-line parameter to specify the absolute file name of the model to produce
static String	PARAMETER_WORK_DIR Doclet command-line parameter to specify the directory of model file to produce

Method Summary

Modifier and Type	Method and Description
static com.sun.javadoc.LanguageVersion	languageVersion() Indicates support of generics and annotations
static int	optionLength(String option) This method is required by the doclet convention.
static boolean	start(com.sun.javadoc.RootDoc root) The doclet entry point as of Doclet interface specified.
static boolean	validOptions(String[][] options, com.sun.javadoc.DocErrorReporter reporter) This method parses the option parameters and sets the proper parameters of this doclet

Methods inherited from class java.lang.Object

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

Field Detail

PARAMETER_TARGET_FILE

public static final String PARAMETER_TARGET_FILE

Doclet command-line parameter to specify the absolute file name of the model to produce

See Also:

Constant Field Values

PARAMETER_WORK_DIR

public static final String PARAMETER_WORK_DIR

Doclet command-line parameter to specify the directory of model file to produce

See Also:

Constant Field Values

PARAMETER_MODEL

public static final String PARAMETER_MODEL

Doclet command-line parameter with the name of the model to construct

See Also:

Constant Field Values

Method Detail

start

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

The doclet entry point as of Doclet interface specified.

Parameters:

root -

Returns:

true if model extraction completed successfully

See Also:

Doclet.start(com.sun.javadoc.RootDoc)

optionLength

public static int optionLength(String option)

This method is required by the doclet convention. It checks the option provided and returns the number of parameters it requires + 1 (the option itself).

Parameters:

option - is the non-null, not empty option name to read parameters of

Returns:

0 as the number of options it requires including the option itself. 0 means that the option is not used, -1 - an error occurred

See Also:

Doclet.optionLength(java.lang.String)

validOptions

public static boolean validOptions(String[][] options,
                                   com.sun.javadoc.DocErrorReporter reporter)

This method parses the option parameters and sets the proper parameters of this doclet

Parameters:

options -

reporter -

Returns:

true when correct options provided

See Also:

Doclet.validOptions(java.lang.String[][], com.sun.javadoc.DocErrorReporter)

languageVersion

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

Indicates support of generics and annotations