UML Modeling Guide

Stereotype «ToDo»

Stereotype «ToDo»

The stereotype «ToDo» marks a model element for which business or technical changes are planned.

The types of changes can be specified using the tagged value plannedChanges.

Examples:

  • Preparing a future deprecation once the replacement mechanism is available.
  • Introducing a new property that will become mandatory once the provider-side implementation is ready.


Stereotype «ToDo»  
Applicable Elements NamedElement  
Tagged Values    
Name Type Description
plannedChanges ToDoType Changes that are planned for the element under construction.

The following ToDo types are supported:
- CHANGE_ELEMENT_TO_MANDATORY: Element should be changed to mandatory.

- CHANGE_ELEMENT_TO_OPTIONAL: Element should be changed to optional.

- REMOVE_ELEMENT: Element should be removed.

- REMOVE_ELEMENT_WITH_REPLACEMENT: Element should be replaced.

- DEPRECATE_ELEMENT: Element should be marked as deprecated.

- DEPRECATE_ELEMENT_WITH_REPLACEMENT: Element should be marked as deprecated and will have a replacement.

- RENAME_ELEMENT: Element should be renamed.

- CHANGE_ELEMENT_TO_MULTI_VALUED: Multiplicity of the element should be changed to multi-valued.

- CHANGE_ELEMENT_TO_SINGLE_VALUED: Multiplicity should be changed to single-valued.

- CHANGE_PACKAGE: Element should be moved to another package.

- TIGHTEN_CONSTRAINT: Constraint on element should be change to be more tight.

- SOFTEN_CONSTRAINT: Constraint on element should be changed to be less tight.

- ADD_DEPENDENCY: Ann additional dependency should be added.

- REMOVE_DEPENDENCY: An existing dependency should be removed.

- NOT_YET_IMPLEMENTED: Element is not yet implemented.

- NOT_YET_SUPPORTED: Element is not yet supported.

- UPDATE_DOCUMENTATION: Documentation should be updated.

- OTHER: Other type of ToDo. This type is used if none of the ones above matches.

- UNDEFINED: Type of ToDo is undefined.
description String Detailed description what of the element is under construction and is supposed to be changed in the future.
since String Information when the ToDo tag was add for a model element e.g. a concrete version or date.


Generated by JEAF Generator