Class, Inner Class, and Interface Properties

This section describes the properties specific to classes, inner classes, and interfaces. Every element has general properties as well as specific properties. For more information, see General Properties. The composition of the Properties view changes depending on the element selected in the Diagram or UML Navigator view. You can view and modify values of properties through the Properties view.

Class, Inner Class, and Interface Properties

abstract:(Class only) Set this value to true or false using the drop down menu.

alias: Allows you to give an element a name that would not normally be accepted for that element. For example, use the alias property to represent a class name with spaces to make it more readable. Using the alias property does not effect the original name. The Diagram view shows the alias for an element.

extends: If a class extends another class, use the drop down arrow to select the appropriate class.

file: Lists the file name and its location in the project directory.

final:(Class only) Set this value as true or false from the drop down list.

implements:(Class only) If a class implements an interface, use the drop down arrow to select the appropriate interface.

invariants: This field allows you to enter text describing what is always true for all instances of a class.

name: The name of the class, inner class or interface.

package: The package the class or inner class belongs to.

persistent: Set this value as true or false using the drop down list.

public:(Class only) Set this value as true or false using the drop down list.

stereotype: Choose the appropriate stereotype from the drop down list, or add your own stereotype. The available stereotypes are:

• idl-Interface
• abstract factory
• actor
• boundary
• container
• control
• description
• entity
• enumeration
• exception
• factory
• implementation class
• interface
• metaclass
• rmi-detail
• moment-interval
• party
• place
• plug-in point
• powertype
• process
• role
• stereotype
• struct
• thing
• thread
• type
• union
• utility
• visitor

Javadoc

The Properties view for source-generating elements also displays Javadoc properties. Using javadoc tags enables you to automatically generate a complete, well-formatted API from your source code. You can enter a description and specify values for Javadoc tags applicable to the selected element. These values are used when you generate Javadoc using the Documentation Generation feature of Together (File > Export > UML Documentation).

Filling in the Javadoc fields automatically generates appropriate tags in the Javadoc tags in the source code. @author and @see tags allow multiple values. In this case, the values are separated by commas in the Properties field.

author: Creates an "Author" entry. This field may contain multiple @author tags.

deprecated: Adds a comment to the generated documentation indicating that the API is deprecated and should no longer be used (even though it may continue to work).

see: Adds a hyperlinked "See also" entry when using the Documentation Generation feature. For example, @see java.lang.String.

since: Adds a "Since" entry with the specified since-text to the generated documentation. This tag indicates that this change or feature has existed since the software release specified by the since-text.

version: Adds a "Version" entry to the class. A doc comment may contain at most one @version tag.