Operation Properties

This section describes the properties specific to operations (methods) of 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.

Operation Properties

abstract: Set this value as true or false from the drop down list.

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.

final: Set this value as true or false from the drop down list.

input: This field allows you to enter text describing the inputs for an operation.

name: The name of the operation.

native: Set this value as true or false from the drop down list.

output: This field allows you to enter text describing the outputs for an operation.

parameters: Add the parameters for an operation using this field.

post-condition: This field allows you to enter text describing the post-conditions for an operation.

pre-condition: This field allows you to enter text describing the pre-conditions for a method an operation.

return value: Specify the return value of a method. Choose the appropriate return value from the drop down list.

semantics: This field allows you to enter text describing the semantics of an operation.

static: Set this value as true or false from the drop down list.

stereotype: Choose the appropriate stereotype from the drop down list.

synchronized: Set this value as true or false from the drop down list.

throws: Use the drop down list to select the appropriate throws statement.

time: This field allows you to enter text for the time requirement of an operation.

visibility: Set the visibility for the operation from the drop down list. Choose from public, private, protected, or package local.


NB: Abstract, final, native, static, synchronized and visibility properties apply only for Class operations.


Javadoc Properties

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.

comment: Adds a comment to the source code. The comment is displayed in the generated documentation.

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).

exception: Use the @exception tag in place of the @throws tag. Use the file chooser button to designate the class-name of the exception that may be thrown by the method. A "Throws" heading is inserted in the generated documentation.

params: Adds a parameter to the "Parameters" section. You can insert multiple values in this field.

return: Use this field to add a "Returns" comment with the description text. The text should describe the return type and a permissible range of values.

see: Adds a hyperlinked "See also" entry when using the Documentation Generation feature.

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.