User's Guide

Introduction

Only class diagrams for existing Java classes are supported. They are based on the OMG's UML 1.5 specification (see http://www.omg.org/uml/). Class diagrams can contain existing classes, interfaces, enumerations, annotations (called \classifiers henceforth in accordance with UML 1.5) as well as packages and package roots (i.e. JARs and source folders). A diagram only reflects the existing source code, which cannot be manipulated through the diagram.

Class diagrams are created with a wizard. Simply select the package (or folder) where the diagram should be stored and either press Ctrl+N or right-click and select 'New', then 'Other...'; in the 'New' wizard dialog select 'UML Diagram' and 'Class Diagram'.

Class diagrams are XML files with the extension '.ucls' and are excluded from the Java resource copy process, i.e. they are not copied into the output folder by the Java builder.

All user interaction with the class diagram is either graphical (clicking, dragging, drag and drop) or with context menus. Exceptions:

Eclipse refactoring is fully supported. Refactoring updates all diagrams in the workspace appropriately. The only exception are deletions affecting diagrams that are not open in an editor; those are handled when diagram is opened.

Integration with Views

The Outline View shows all nodes in a diagram, along with their fields and methods. Selecting a node in the outline also selects it in the diagram (and scrolls the diagram to its position if necessary) and vice verse. Below the outline is a thumbnail of the entire diagram, which allows easy navigation in large diagrams.

The Javadoc View shows the documentation of the selected classfier. Similarly, the Declaration View shows the source code of the currently selected classifier.

The Console View contains a log of problems that occurred when a diagram was opened. This can be due to an invalid or outdated diagram, or simply because some Java elements or relationships don't exist any more and had to be deleted. The diagram's name is a hyperlink and clicking on it opens the diagram.

The References context menu of a classifier displays search results as usual in the Search View, from which classifiers can be dragged onto the diagram.

The Open Type Hierarchy context menu of a classifier shows its inheritance hierarchy as usual, from which classifiers can be dragged onto the diagram.

Classifiers

In the context of this document, a classifier is a Java type. Java classes, interfaces, enumerations and annotations are the supported classifiers.

Source and binary classifiers can be added to the diagram in various ways (as long as they are not there already):

Packages and package roots (i.e. JARs and source folders) can be dragged from the Package Explorer

Various display options are available for classifiers:

Layout options for classifiers include:

Relationships

The following relationship types are supported: Generalization, Realization, Association, Dependency, Nesting. When a classifier is added to a diagram, relationships to other classifiers in the diagram are reverse engineered. They can be deleted from the diagram and reverse engineered again later.

The attribute and multiplicity labels of associations are auto-located by default, but can also be moved manually. The display options for association labels are:

Known Issues and Limitations